aci_epg_subnet
Manage EPG Subnets (fv:Subnet)
Collection: cisco.aci
Full Name: cisco.aci.aci_epg_subnet
Synopsis
Manage EPG Subnets (fv:Subnet)
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. | ||
| description | string | The description for the Subnet. | ||
| enable_vip | bool | Determines if the Subnet should be treated as a VIP (virtual IP address). The APIC defaults to C(false) when unset during creation. | ||
| epg | string | Name of the end point group. | ||
| gateway | string | The IPv4 or IPv6 gateway address for the Subnet. | ||
| 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. | ||
| ip_data_plane_learning | string | Whether IP data plane learning is enabled or disabled. The APIC defaults to C(enabled) when unset during creation. | ||
| mask | int | The subnet mask for the Subnet. This is the number associated with CIDR notation. For IPv4 addresses, accepted values range between C(0) and C(32). For IPv6 addresses, accepted Values range between C(0) and C(128). | ||
| name_alias | string | The alias for the current object. This relates to the nameAlias field in ACI. | ||
| nd_prefix_policy | string | The IPv6 Neighbor Discovery Prefix Policy to associate with 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. | ||
| preferred | bool | Determines if the Subnet is preferred over all available Subnets. Only one Subnet per Address Family (IPv4/IPv6) can be preferred in the Bridge Domain. The APIC defaults to C(false) when unset during creation. | ||
| 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. | ||
| route_profile | string | The Route Profile to the associate with the Subnet. | ||
| route_profile_l3out | string | The L3Out that contains the associated Route Profile. | ||
| scope | list | Determines the scope of the Subnet. The C(private) option only allows communication with hosts in the same VRF. The C(public) option allows the Subnet to be advertised outside of the ACI Fabric, and allows communication with hosts in other VRFs. The shared option limits communication to hosts in either the same VRF or the shared VRF. The value is a list of options, C(private) and C(public) are mutually exclusive, but both can be used with C(shared). The APIC defaults to C(private) when unset during creation. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| subnet_control | string | Determines the Subnet’s Control State. The C(querier_ip) option is used to treat the gateway_ip as an IGMP querier source IP. The C(nd_ra) option is used to treat the gateway_ip address as a Neighbor Discovery Router Advertisement Prefix. The C(no_gw) option is used to remove default gateway functionality from the gateway address. The APIC defaults to C(nd_ra) when unset during creation. | ||
| subnet_name | string | The name of the Subnet. | ||
| 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 | The 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. |
Example
yaml
- {"cisco.aci.aci_epg_subnet": {"ap": "intranet", "epg": "web_epg", "gateway": "10.1.1.1", "host": "apic", "mask": 24, "password": "SomeSecretPassword", "state": "present", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Create a subnet"}
- {"cisco.aci.aci_epg_subnet": {"ap": "intranet", "description": "SQL Servers", "epg": "web_epg", "gateway": "10.1.2.1", "host": "apic", "mask": 23, "password": "SomeSecretPassword", "route_profile": "corp_route_profile", "route_profile_l3out": "corp", "scope": "public", "state": "present", "subnet_name": "sql", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Create a subnet with options"}
- {"cisco.aci.aci_epg_subnet": {"ap": "intranet", "epg": "web_epg", "gateway": "10.1.1.1", "host": "apic", "mask": 24, "password": "SomeSecretPassword", "scope": ["private", "shared"], "state": "present", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Update a subnets scope to private and shared"}
- {"cisco.aci.aci_epg_subnet": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Get all subnets"}
- {"cisco.aci.aci_epg_subnet": {"gateway": "10.1.1.1", "host": "apic", "mask": 24, "password": "SomeSecretPassword", "state": "query", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Get all subnets of specific gateway in specified tenant", "register": "query_result"}
- {"cisco.aci.aci_epg_subnet": {"ap": "intranet", "epg": "web_epg", "gateway": "10.1.1.1", "host": "apic", "mask": 24, "password": "SomeSecretPassword", "state": "query", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Get specific subnet", "register": "query_result"}
- {"cisco.aci.aci_epg_subnet": {"ap": "intranet", "epg": "web_epg", "gateway": "10.1.1.1", "host": "apic", "mask": 24, "password": "SomeSecretPassword", "state": "absent", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Delete a subnet"}