aci_l3out_extsubnet
Manage External Subnet objects (l3ext:Subnet)
Collection: cisco.aci
Full Name: cisco.aci.aci_l3out_extsubnet
Synopsis
Manage External Subnet objects (l3ext:Subnet)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| aggregate | list | Determines the Aggregate Routes for the Subnet. The C(export-rtctrl) option to export all transit routes of a VRF (0/0 subnets). The C(import-rtctrl) option to import all incoming routes of given L3 peers (0/0 subnets). The C(shared-rtctrl) option to share routes learned in one VRF which needs to be advertised to another VRF. 0/0 can be used to share all subnet routes across multiple VRFs. The C(import-rtctrl) is only supported for BGP and OSPF. Aggregate import route control is only available if the L3Out has ‘Import Route Control Enforcement’ enabled. Default this is disabled, M(cisco.aci.aci_l3out) with C(route_control) can be used to enable. | ||
| 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. | ||
| description | string | Description for the External Subnet. | ||
| extepg | string | yes | Name of an existing ExtEpg. | |
| 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. | ||
| l3out | string | yes | Name of an existing L3Out. | |
| name_alias | string | The alias for the current object. This relates to the nameAlias field in ACI. | ||
| network | string | The network address for the Subnet. | ||
| 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. | ||
| 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. | ||
| scope | list | Determines the scope of the Subnet. The C(export-rtctrl) option controls which external networks are advertised out of the fabric using route-maps and IP prefix-lists. The C(import-rtctrl) option controls which external networks are advertised in to the fabric using route-maps and IP prefix-lists. The C(import-security) option classifies for the external EPG. The rules and contracts defined in this external EPG apply to networks matching this subnet. The C(shared-rtctrl) option controls which external prefixes are advertised to other tenants for shared services. The C(shared-security) option configures the classifier for the subnets in the VRF where the routes are leaked. The APIC defaults to C(import-security) when unset during creation. The C(import-rtctrl) is only supported for BGP and OSPF. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| subnet_name | string | Name of External Subnet being created. | ||
| 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 | yes | 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_l3out_extsubnet": {"aggregate": "export-rtctrl", "description": "External Subnet for Production ExtEpg", "extepg": "prod_extepg", "host": "apic", "l3out": "prod_l3out", "network": "192.0.2.0/24", "password": "SomeSecretPassword", "scope": "export-rtctrl", "state": "present", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Add a new External Subnet"}
- {"cisco.aci.aci_l3out_extsubnet": {"extepg": "prod_extepg", "host": "apic", "l3out": "prod_l3out", "network": "192.0.2.0/24", "password": "SomeSecretPassword", "state": "absent", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Delete External Subnet"}
- {"cisco.aci.aci_l3out_extsubnet": {"extepg": "prod_extepg", "host": "apic", "l3out": "prod_l3out", "network": "192.0.2.0/24", "password": "SomeSecretPassword", "state": "query", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Query ExtEpg Subnet information", "register": "query_result"}