aci_bd_subnet – Manage Subnets (fv:Subnet)
aci_bd_subnet – Manage Subnets (fv:Subnet)
New in version 2.4.
Synopsis
- Manage Subnets on Cisco ACI fabrics.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
bd - |
The name of the Bridge Domain.
| |
certificate_name - |
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. It defaults to the
| |
description - |
The description for the Subnet.
| |
enable_vip boolean |
|
Determines if the Subnet should be treated as a VIP; used when the BD is extended to multiple sites. The APIC defaults to |
gateway - |
The IPv4 or IPv6 gateway address for the Subnet.
| |
host - / required |
IP Address or hostname of APIC resolvable by Ansible control host.
| |
mask integer |
The subnet mask for the Subnet. This is the number assocated with CIDR notation. For IPv4 addresses, accepted values range between For IPv6 addresses, accepted Values range between
| |
nd_prefix_policy - |
The IPv6 Neighbor Discovery Prefix Policy to associate with the Subnet. | |
output_level - |
|
Influence the output of this ACI module.
|
password - / required |
The password to use for authentication. This option is mutual exclusive with | |
port - |
Port number to be used for REST connection. The default value depends on parameter `use_ssl`. | |
preferred boolean |
|
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 |
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 This option is mutual exclusive with
| |
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 |
|
Determines the scope of the Subnet. The The The shared option limits communication to hosts in either the same VRF or the shared VRF. The value is a list of options, The APIC defaults to |
state - |
|
Use Use |
subnet_control - |
|
Determines the Subnet's Control State. The The The The APIC defaults to |
subnet_name - |
The name of the Subnet.
| |
tenant - |
The name of the Tenant.
| |
timeout integer |
Default: 30 |
The socket level timeout in seconds. |
use_proxy boolean |
|
If |
use_ssl boolean |
|
If |
username - |
Default: "admin" |
The username to use for authentication.
|
validate_certs boolean |
|
If This should only set to |
Notes
Note
- The
gateway
parameter is the root key used to access the Subnet (not name), so thegateway
is required when the state isabsent
orpresent
. - The
tenant
andbd
used must exist before using this module in your playbook. The aci_tenant module and aci_bd can be used for these.
See Also
See also
- aci_bd – Manage Bridge Domains (BD) objects (fv:BD)
- The official documentation on the aci_bd module.
- aci_tenant – Manage tenants (fv:Tenant)
- The official documentation on the aci_tenant module.
- Cisco ACI Guide
- Detailed information on how to manage your ACI infrastructure using Ansible.
- Developing Cisco ACI modules
- Detailed guide on how to write your own Cisco ACI modules to contribute.
Examples
- name: Create a tenant
aci_tenant:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
state: present
delegate_to: localhost
- name: Create a bridge domain
aci_bd:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
state: present
delegate_to: localhost
- name: Create a subnet
aci_bd_subnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
gateway: 10.1.1.1
mask: 24
state: present
delegate_to: localhost
- name: Create a subnet with options
aci_bd_subnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
subnet_name: sql
gateway: 10.1.2.1
mask: 23
description: SQL Servers
scope: public
route_profile_l3_out: corp
route_profile: corp_route_profile
state: present
delegate_to: localhost
- name: Update a subnets scope to private and shared
aci_bd_subnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
gateway: 10.1.1.1
mask: 24
scope: [private, shared]
state: present
delegate_to: localhost
- name: Get all subnets
aci_bd_subnet:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
- name: Get all subnets of specific gateway in specified tenant
aci_bd_subnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
gateway: 10.1.1.1
mask: 24
state: query
delegate_to: localhost
register: query_result
- name: Get specific subnet
aci_bd_subnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
gateway: 10.1.1.1
mask: 24
state: query
delegate_to: localhost
register: query_result
- name: Delete a subnet
aci_bd_subnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
gateway: 10.1.1.1
mask: 24
state: absent
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
current list |
success |
The existing configuration from the APIC after the module has finished
Sample: [{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
error dictionary |
failure |
The error information as returned from the APIC
Sample: {'code': '122', 'text': 'unknown managed object class foo'} |
filter_string string |
failure or debug |
The filter string used for the request
Sample: ?rsp-prop-include=config-only |
method string |
failure or debug |
The HTTP method used for the request to the APIC
Sample: POST |
previous list |
info |
The original configuration from the APIC before the module has started
Sample: [{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
proposed dictionary |
info |
The assembled configuration from the user-provided parameters
Sample: {'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}} |
raw string |
parse error |
The raw output returned by the APIC REST API (xml or json)
Sample:
|
response string |
failure or debug |
The HTTP response from the APIC
Sample: OK (30 bytes) |
sent list |
info |
The actual/minimal configuration pushed to the APIC
Sample: {'fvTenant': {'attributes': {'descr': 'Production environment'}}} |
status integer |
failure or debug |
The HTTP status from the APIC
Sample: 200 |
url string |
failure or debug |
The HTTP url used for the request to the APIC
Sample: |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Jacob McGill (@jmcgill298)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/aci_bd_subnet_module.html