Skip to content

avi_webapput.rst

Latest commit

 

History

History
599 lines (579 loc) · 24.9 KB

avi_webapput.rst

File metadata and controls

599 lines (579 loc) · 24.9 KB

vmware.alb.avi_webapput

Module for setup of WebappUT Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.5, 22.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
default_first_int
int
- Default uint64 field.
- Field introduced in 30.1.2.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 1.
default_second_int
int
- Default int64 field.
- Field introduced in 30.1.2.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 2.
default_string
str
- Default string field.
- Field introduced in 30.1.2.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as default string.
default_third_int
int
- Default int32 field.
- Field introduced in 30.1.2.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 3.
mandatory_test
dict
- Optional message for nested f_mandatory test cases defined at level1.
- Field introduced in 21.1.5, 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
mandatory_tests
list
- Repeated message for nested f_mandatory test cases-level1.
- Field introduced in 21.1.5, 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
name
str
required: true
- Name of the webapput object-level0.
- Field introduced in 21.1.5, 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
sensitive_test
dict
- Optional message for nested f_sensitive test cases defined at level1.
- Field introduced in 22.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
sensitive_tests
list
- Repeated message for nested f_sensitive test cases-level1.
- Field introduced in 22.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
skip_optional_check_tests
bool
- Optional bool for nested skip_optional_check test cases-level1.
- Field introduced in 22.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
string_length_test
dict
- Optional message for nested max string length test cases.
- Field introduced in 21.1.5, 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
string_length_tests
list
- Repeated message for nested max string length test cases.
- Field introduced in 21.1.5, 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
tenant_ref
str
- Tenant of the webapput object-level0.
- It is a reference to an object of type tenant.
- Field introduced in 21.1.5, 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
test_sensitive_string
str
- The string for sensitive (secret) field.
- Object-level0.
- Field introduced in 22.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
test_string
str
- The maximum string length.
- Field introduced in 21.1.5, 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of the webapput object-level0.
- Field introduced in 21.1.5, 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create WebappUT object
      avi_webapput:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_webapput

Authors