aci_static_binding_to_epg
Bind static paths to EPGs (fv:RsPathAtt)
Collection: cisco.aci
Full Name: cisco.aci.aci_static_binding_to_epg
Synopsis
Bind static paths to EPGs (fv:RsPathAtt)
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. | |
| ap | string | Name of an existing application network profile, that will contain the EPGs. | ||
| 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. | ||
| deploy_immediacy | string | The Deployment Immediacy of Static EPG on PC, VPC or Interface. The APIC defaults to C(lazy) when unset during creation. | ||
| description | string | Description for the static path to EPG binding. | ||
| encap_id | int | The encapsulation ID associating the C(epg) with the interface path. This acts as the secondary C(encap_id) when using micro-segmentation. Accepted values are any valid encap ID for specified encap, currently ranges between C(1) and C(4096). | ||
| epg | string | The name of the end point group. | ||
| extpaths | list | The C(extpaths) integer value part of the tDn. C(extpaths) is only used if C(interface_type) is C(fex), C(fex_vpc) or C(fex_port_channel). When C(interface_type) is C(fex_vpc), then C(extpaths) is a list with both fex IDs. Usually something like C(1011). | ||
| 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. | ||
| interface | string | The C(interface) string value part of the tDn. Usually a policy group like C(test-IntPolGrp) or an interface of the following format C(1/7) depending on C(interface_type). | ||
| interface_mode | string | Determines how layer 2 tags will be read from and added to frames. Values C(802.1p) and C(native) are identical. Values C(access) and C(untagged) are identical. Values C(regular), C(tagged) and C(trunk) are identical. The APIC defaults to C(trunk) when unset during creation. | ||
| interface_type | string | switch_port | The type of interface for the static EPG deployment. | |
| leafs | list | The switch ID(s) that the C(interface) belongs to. When C(interface_type) is C(switch_port), C(port_channel), or C(fex), then C(leafs) is a string of the leaf ID. When C(interface_type) is C(vpc), then C(leafs) is a list with both leaf IDs. The C(leafs) value is usually something like ‘101’ or ‘101-102’ depending on C(connection_type). | ||
| 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. | ||
| pod_id | int | The pod number part of the tDn. C(pod_id) is usually an integer below C(10). | ||
| 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. | ||
| primary_encap_id | string | Determines the primary encapsulation ID associating the C(epg) with the interface path when using micro-segmentation. Accepted values are any valid encap ID for specified encap, currently ranges between C(1) and C(4096) and C(unknown). C(unknown) is the default value and using C(unknown) disables the Micro-Segmentation. | ||
| 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 an existing 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. |
Example
yaml
- {"cisco.aci.aci_static_binding_to_epg": {"ap": "accessport_code_app", "deploy_immediacy": "lazy", "encap_id": 222, "epg": "accessport_epg1", "host": "apic", "interface": "1/7", "interface_mode": "untagged", "interface_type": "switch_port", "leafs": 101, "password": "SomeSecretPassword", "pod_id": 1, "state": "present", "tenant": "accessport-code-cert", "username": "admin"}, "delegate_to": "localhost", "name": "Deploy Static Path binding for given EPG"}
- {"cisco.aci.aci_static_binding_to_epg": {"ap": "accessport_code_app", "epg": "accessport_epg1", "host": "apic", "interface": "1/7", "interface_type": "switch_port", "leafs": 101, "password": "SomeSecretPassword", "pod": 1, "state": "absent", "tenant": "accessport-code-cert", "username": "admin"}, "delegate_to": "localhost", "name": "Remove Static Path binding for given EPG"}
- {"cisco.aci.aci_static_binding_to_epg": {"ap": "accessport_code_app", "epg": "accessport_epg1", "host": "apic", "interface": "1/7", "interface_type": "switch_port", "leafs": 101, "password": "SomeSecretPassword", "pod": 1, "state": "query", "tenant": "accessport-code-cert", "username": "admin"}, "delegate_to": "localhost", "name": "Get specific Static Path binding for given EPG", "register": "query_result"}