Skip to content

Latest commit

 

History

History
403 lines (382 loc) · 15.8 KB

avi_stringgroup.rst

File metadata and controls

403 lines (382 loc) · 15.8 KB

vmware.alb.avi_stringgroup

Module for setup of StringGroup 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.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
description
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
kv
list
- Configure key value in the string group.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
longest_match
bool
- Enable the longest match, default is the shortest match.
- Field introduced in 18.2.8.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
markers
list
- List of labels to be used for granular rbac.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
name
str
required: true
- Name of the string group.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tenant_ref
str
- It is a reference to an object of type tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
type
str
required: true
- Type of stringgroup.
- Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as SG_TYPE_STRING.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of the string group.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "{{ username }}"
      password: "{{ password }}"
      controller: "{{ controller }}"
      api_version: "{{ api_version }}"
  tasks:
    - name: Create a string group configuration
      avi_stringgroup:
        avi_credentials: "{{ avi_credentials }}"
        kv:
        - key: text/html
        - key: text/xml
        - key: text/plain
        - key: text/css
        - key: text/javascript
        - key: application/javascript
        - key: application/x-javascript
        - key: application/xml
        - key: application/pdf
        name: System-Compressible-Content-Types
        tenant_ref: /api/tenant?name=admin
        type: SG_TYPE_STRING

Authors