aci_fabric_wide_settings
Manage fabric-wide settings on Cisco ACI
Collection: cisco.aci
Full Name: cisco.aci.aci_fabric_wide_settings
Synopsis
Manage fabric-wide settings on Cisco ACI
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| disable_remote_ep_learning | bool | Whether to disable remote endpoint learning in VRFs containing external bridged/routed domains. The APIC defaults to C(false) when unset during creation. | ||
| enforce_domain_validation | bool | Whether to perform a validation check if a static path is added but no domain is associated to an EPG. Asking for domain validation is a one time operation. Once enabled, it cannot be disabled. The APIC defaults to C(false) when unset during creation. | ||
| enforce_epg_vlan_validation | bool | Whether to perform a validation check that prevents overlapping VLAN pools from being associated to an EPG. The APIC defaults to C(false) when unset during creation. | ||
| enforce_subnet_check | bool | Whether to disable IP address learning on the outside of subnets configured in a VRF, for all VRFs. The APIC defaults to C(false) when unset during creation. | ||
| host | string | IP Address or hostname of APIC resolvable by Ansible control host. If the value is not specified in the task, the value of environment variable C(ACI_HOST) will be used instead. | ||
| leaf_opflex_client_auth | bool | Whether to enforce Opflex client certificate authentication on leaf switches for GOLF and Linux. The APIC defaults to C(true) when unset during creation. | ||
| leaf_ssl_opflex | bool | Whether to enable SSL Opflex transport for leaf switches. The APIC defaults to C(true) when unset during creation. | ||
| opflex_ssl_versions | list | Which versions of TLS to enable for Opflex. When setting any of the TLS versions, you must explicitly set the state for all of them. | ||
| output_level | string | normal | Influence the output of this ACI module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| output_path | string | Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_PATH) will be used instead. | ||
| owner_key | string | User-defined string for the ownerKey attribute of an ACI object. This attribute represents a key for enabling clients to own their data for entity correlation. If the value is not specified in the task, the value of environment variable C(ACI_OWNER_KEY) will be used instead. | ||
| owner_tag | string | User-defined string for the ownerTag attribute of an ACI object. This attribute represents a tag for enabling clients to add their own data. For example, to indicate who created this object. If the value is not specified in the task, the value of environment variable C(ACI_OWNER_TAG) will be used instead. | ||
| password | string | The password to use for authentication. This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| private_key | string | Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| reallocate_gipo | bool | Whether to reallocate some non-stretched BD gipos to make room for stretched BDs. Asking for gipo reallocation is a one time operation. Once enabled, it cannot be disabled. The APIC defaults to C(false) when unset during creation. | ||
| restrict_infra_vlan_traffic | bool | Whether to restrict infra VLAN traffic to only specified network paths. These enabled network paths are defined by infra security entry policies. The APIC defaults to C(false) when unset during creation. | ||
| spine_opflex_client_auth | bool | Whether to enforce Opflex client certificate authentication on spine switches for GOLF and Linux. The APIC defaults to C(true) when unset during creation. | ||
| spine_ssl_opflex | bool | Whether to enable SSL Opflex transport for spine switches. The APIC defaults to C(true) when unset during creation. | ||
| state | string | present | Use C(present) for updating configuration. Use C(query) for showing current configuration. | |
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| use_proxy | bool | If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(false), an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. |
Example
yaml
- {"cisco.aci.aci_fabric_wide_settings": {"disable_remote_ep_learning": true, "enforce_epg_vlan_validation": true, "host": "apic", "password": "SomeSecretPassword", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Update Fabric Wide Settings"}
- {"cisco.aci.aci_fabric_wide_settings": {"host": "apic", "opflex_ssl_versions": ["tls_v1.2"], "password": "SomeSecretPassword", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Update Opflex SSL versions"}
- {"cisco.aci.aci_fabric_wide_settings": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query Fabric Wide Settings", "register": "query_result"}