aci_esg
Manage Endpoint Security Groups (ESGs) objects (fv:ESg)
Collection: cisco.aci
Full Name: cisco.aci.aci_esg
Synopsis
Manage Endpoint Security Groups (ESGs) objects (fv:ESg)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| admin_state | bool | Use C(false) to set ‘Admin Up’ on the ESG Admin state and is the default. Use C(true) to set ‘Admin Shut’ on the ESG Admin state | ||
| 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. | |
| ap | string | The name of the application profile. | ||
| 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. | ||
| description | string | Endpoint security group description. | ||
| esg | string | Name of the Endpoint Security Group. | ||
| 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. | ||
| intra_esg_isolation | string | The default value of Intra ESG Isolation is C(unenforced). | ||
| name_alias | string | The alias for the current object. This relates to the nameAlias field in ACI. | ||
| 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. | ||
| 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. | ||
| preferred_group_member | string | The default value of Preferred Group Member is C(exclude). | ||
| 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. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| 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. | ||
| tenant | string | Name of the tenant. | ||
| 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. | ||
| vrf | string | Name of the VRF |
Example
yaml
- {"cisco.aci.aci_esg": {"ap": "intranet", "description": "Web Intranet ESG", "esg": "web_esg", "host": "apic", "password": "SomeSecretPassword", "state": "present", "tenant": "production", "username": "admin", "vrf": "default"}, "delegate_to": "localhost", "name": "Add a new ESG"}
- {"cisco.aci.aci_esg": {"ap": "ticketing", "description": "Ticketing ESG", "esg": "{{ item.esg }}", "host": "apic", "password": "SomeSecretPassword", "state": "present", "tenant": "production", "username": "admin", "vrf": "default"}, "delegate_to": "localhost", "name": "Add list of ESGs", "with_items": [{"esg": "web"}, {"esg": "database"}]}
- {"cisco.aci.aci_esg": {"ap": "ticketing", "esg": "web_esg", "host": "apic", "password": "SomeSecretPassword", "state": "query", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Query an ESG"}
- {"cisco.aci.aci_esg": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all ESGs"}
- {"cisco.aci.aci_esg": {"esg": "web_esg", "host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all ESGs with a Specific Name"}
- {"cisco.aci.aci_esg": {"ap": "ticketing", "host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all ESGs of an App Profile"}
- {"cisco.aci.aci_esg": {"app_profile": "intranet", "esg": "web_esg", "host": "apic", "password": "SomeSecretPassword", "state": "absent", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Remove an ESG"}