Skip to content

avi_systemconfiguration.rst

Latest commit

 

History

History
803 lines (782 loc) · 35.7 KB

avi_systemconfiguration.rst

File metadata and controls

803 lines (782 loc) · 35.7 KB

vmware.alb.avi_systemconfiguration

Module for setup of SystemConfiguration 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.
admin_auth_configuration
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
common_criteria_mode
bool
- Common criteria mode's current state.
- Field introduced in 20.1.3.
- 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 False.
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.
controller_analytics_policy
dict
- Controller metrics event dynamic thresholds can be set here.
- Controller_cpu_high and controller_mem_high evets can take configured dynamic thresholds.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
default_license_tier
str
- Specifies the default license tier which would be used by new clouds.
- Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS, ENTERPRISE_WITH_CLOUD_SERVICES.
- Field introduced in 17.2.5.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Special default for essentials edition is essentials, basic edition is basic, enterprise is enterprise_with_cloud_services.
- Default value when not specified in API or module is interpreted by Avi Controller as ENTERPRISE_WITH_CLOUD_SERVICES.
dns_configuration
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
dns_virtualservice_refs
list
- Dns virtualservices hosting fqdn records for applications across avi vantage.
- If no virtualservices are provided, avi vantage will provide dns services for configured applications.
- Switching back to avi vantage from dns virtualservices is not allowed.
- It is a reference to an object of type virtualservice.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
docker_mode
bool
- 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.
email_configuration
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
enable_cors
bool
- Enable cors header.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
fips_mode
bool
- Fips mode current state.
- Field introduced in 20.1.1.
- 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.
global_tenant_config
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
host_key_algorithm_exclude
str
- Users can specify comma separated list of deprecated host key algorithm.if nothing is specified, all known algorithms provided by openssh will be
- supported.this change could only apply on the controller node.
- Field introduced in 22.1.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
kex_algorithm_exclude
str
- Users can specify comma separated list of deprecated key exchange algorithm.if nothing is specified, all known algorithms provided by openssh
- will be supported.this change could only apply on the controller node.
- Field introduced in 22.1.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
linux_configuration
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
mgmt_ip_access_control
dict
- Configure ip access control for controller to restrict open access.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
ntp_configuration
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
portal_configuration
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
proxy_configuration
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
rekey_time_limit
str
- Users can specify and update the time limit of rekeylimit in sshd_config.if nothing is specified, the default setting will be none.
- Field introduced in 30.2.1.
- 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 none.
rekey_volume_limit
str
- Users can specify and update the size/volume limit of rekeylimit in sshd_config.if nothing is specified, the default setting will be default.
- Field introduced in 30.2.1.
- 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.
secure_channel_configuration
dict
- Configure secure channel properties.
- Field introduced in 18.1.4, 18.2.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
snmp_configuration
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
ssh_ciphers
list
- Allowed ciphers list for ssh to the management interface on the controller and service engines.
- If this is not specified, all the default ciphers are allowed.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
ssh_hmacs
list
- Allowed hmac list for ssh to the management interface on the controller and service engines.
- If this is not specified, all the default hmacs are allowed.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
welcome_workflow_complete
bool
- This flag is set once the initial controller setup workflow is complete.
- Field introduced in 18.2.3.
- 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.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "{{ username }}"
      password: "{{ password }}"
      controller: "{{ controller }}"
      api_version: "{{ api_version }}"
  tasks:
    - hosts: all
      vars:
        avi_credentials:
          username: "admin"
          password: "something"
          controller: "192.168.15.18"
          api_version: "21.1.1"
      tasks:
        - name: Example to create SystemConfiguration object
          vmware.alb.avi_systemconfiguration:
            avi_credentials: "{{ avi_credentials }}"
            state: present
            welcome_workflow_complete: True
            dns_configuration:
              search_domain: ''
              server_list:
                - type: V4
                  addr: "8.8.8.8"
                - type: DNS
                  addr: "dns.rainpole.com"

Authors