Parameter |
Choices/Defaults |
Comments |
bd
|
|
The name of the Bridge Domain.
aliases: bd_name
|
certificate_name
|
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
It defaults to the private_key basename, without extension.
aliases: cert_name
|
description
|
|
The description for the Subnet.
aliases: descr
|
enable_vip
bool |
|
Determines if the Subnet should be treated as a VIP; used when the BD is extended to multiple sites.
The APIC defaults to no when unset during creation.
|
gateway
|
|
The IPv4 or IPv6 gateway address for the Subnet.
aliases: gateway_ip
|
host
required |
|
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: hostname
|
mask
int |
|
The subnet mask for the Subnet.
This is the number assocated with CIDR notation.
For IPv4 addresses, accepted values range between 0 and 32 .
For IPv6 addresses, accepted Values range between 0 and 128 .
aliases: subnet_mask
|
nd_prefix_policy
|
|
The IPv6 Neighbor Discovery Prefix Policy to associate with the Subnet.
|
output_level
|
Choices:
- debug
- info
normal ←
|
Influence the output of this ACI module.
normal means the standard output, incl. current dict
info adds informational output, incl. previous , proposed and sent dicts
debug adds debugging output, incl. filter_string , method , response , status and url information
|
password
required |
|
The password to use for authentication.
This option is mutual exclusive with private_key . If private_key is provided too, it will be used instead.
|
port
|
|
Port number to be used for REST connection.
The default value depends on parameter `use_ssl`.
|
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 no when unset during creation.
|
private_key
required |
|
PEM formatted file that contains your private key to be used for signature-based authentication.
The name of the key (without extension) is used as the certificate name in ACI, unless certificate_name is specified.
This option is mutual exclusive with password . If password is provided too, it will be ignored.
aliases: cert_key
|
route_profile
|
|
The Route Profile to the associate with the Subnet.
|
route_profile_l3_out
|
|
The L3 Out that contains the assocated Route Profile.
|
scope
list |
Choices:
- private
- public
- shared
|
Determines the scope of the Subnet.
The private option only allows communication with hosts in the same VRF.
The 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, private and public are mutually exclusive, but both can be used with shared .
The APIC defaults to private when unset during creation.
|
state
|
Choices:
- absent
present ←
- query
|
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
|
subnet_control
|
Choices:
- nd_ra
- no_gw
- querier_ip
- unspecified
|
Determines the Subnet's Control State.
The querier_ip option is used to treat the gateway_ip as an IGMP querier source IP.
The nd_ra option is used to treate the gateway_ip address as a Neighbor Discovery Router Advertisement Prefix.
The no_gw option is used to remove default gateway functionality from the gateway address.
The APIC defaults to nd_ra when unset during creation.
|
subnet_name
|
|
The name of the Subnet.
aliases: name
|
tenant
|
|
The name of the Tenant.
aliases: tenant_name
|
timeout
int |
Default:
30
|
The socket level timeout in seconds.
|
use_proxy
bool |
|
If no , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
|
use_ssl
bool |
|
If no , an HTTP connection will be used instead of the default HTTPS connection.
|
username
|
Default:
admin
|
The username to use for authentication.
aliases: user
|
validate_certs
bool |
|
If no , SSL certificates will not be validated.
This should only set to no when used on personally controlled sites using self-signed certificates.
|