W3cubDocs

/Ansible

aci_bd_subnet - Manage Subnets on Cisco ACI fabrics (fv:Subnet)

New in version 2.4.

Synopsis

Requirements (on host that executes module)

  • ACI Fabric 1.0(3f)+

Options

parameter required default choices comments
bd
 no
The name of the Bridge Domain.
description
 no
The description for the Subnet.
enable_vip
 no
  • False
  • True
Determines if the Subnet should be treated as a VIP; used when the BD is extended to multiple sites.
The APIC defaults new Subnets to no.
gateway
 no
The IPv4 or IPv6 gateway address for the Subnet.
aliases: gateway_ip
mask
 no
  • Any 0 to 32 for IPv4 Addresses
  • 0-128 for IPv6 Addresses
The subnet mask for the Subnet.
This is the number assocated with CIDR notation.
aliases: subnet_mask
nd_prefix_policy
 no
The IPv6 Neighbor Discovery Prefix Policy to associate with the Subnet.
preferred
 no
  • False
  • True
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 new Subnets to no.
route_profile
 no
The Route Profile to the associate with the Subnet.
route_profile_l3_out
 no
The L3 Out that contains the assocated Route Profile.
scope
 no private
  • private
  • public
  • shared
Determines if 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 APIC defaults new Subnets to private.
subnet_control
 no nd_ra
  • 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 new Subnets to nd_ra.
subnet_name
 no
The name of the Subnet.
aliases: name
tenant
 no
The name of the Tenant.
aliases: tenant_name

Examples

#

Notes

Note

  • The gateway parameter is the root key used to access the Subnet (not name), so the gateway is required when the state is absent or present.
  • The tenant and bd used must exist before using this module in your playbook. The aci_tenant module and aci_bd can be used for these.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/aci_bd_subnet_module.html