ansible.builtin.aci_bd_subnet (v2.9.0) — module

Install Ansible via pip

Install with pip install ansible==2.9.0

Description

Manage Subnets on Cisco ACI fabrics.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a tenant
  aci_tenant:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: present
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a bridge domain
  aci_bd:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    state: present
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get all subnets
  aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
bd:
    aliases:
    - bd_name
    description:
    - The name of the Bridge Domain.
    type: str

host:
    aliases:
    - hostname
    description:
    - IP Address or hostname of APIC resolvable by Ansible control host.
    required: true
    type: str

mask:
    aliases:
    - subnet_mask
    description:
    - 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).
    type: int

port:
    description:
    - Port number to be used for REST connection.
    - The default value depends on parameter C(use_ssl).
    type: int

scope:
    choices:
    - private
    - public
    - shared
    description:
    - 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.
    type: list

state:
    choices:
    - absent
    - present
    - query
    default: present
    description:
    - Use C(present) or C(absent) for adding or removing.
    - Use C(query) for listing an object or multiple objects.
    type: str

tenant:
    aliases:
    - tenant_name
    description:
    - The name of the Tenant.
    type: str

gateway:
    aliases:
    - gateway_ip
    description:
    - The IPv4 or IPv6 gateway address for the Subnet.
    type: str

timeout:
    default: 30
    description:
    - The socket level timeout in seconds.
    type: int

use_ssl:
    default: true
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    type: bool

password:
    description:
    - 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.
    required: true
    type: str

username:
    aliases:
    - user
    default: admin
    description:
    - The username to use for authentication.
    type: str

preferred:
    description:
    - 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(no) when unset during creation.
    type: bool

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

enable_vip:
    description:
    - Determines if the Subnet should be treated as a VIP; used when the BD is extended
      to multiple sites.
    - The APIC defaults to C(no) when unset during creation.
    type: bool

description:
    aliases:
    - descr
    description:
    - The description for the Subnet.
    type: str

private_key:
    aliases:
    - cert_key
    description:
    - 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.
    required: true
    type: str

subnet_name:
    aliases:
    - name
    description:
    - The name of the Subnet.
    type: str

output_level:
    choices:
    - debug
    - info
    - normal
    default: normal
    description:
    - 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
    type: str

route_profile:
    description:
    - The Route Profile to the associate with the Subnet.
    type: str

subnet_control:
    choices:
    - nd_ra
    - no_gw
    - querier_ip
    - unspecified
    description:
    - 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.
    type: str

validate_certs:
    default: true
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) when used on personally controlled sites using self-signed
      certificates.
    type: bool

certificate_name:
    aliases:
    - cert_name
    description:
    - 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.
    type: str

nd_prefix_policy:
    description:
    - The IPv6 Neighbor Discovery Prefix Policy to associate with the Subnet.
    type: str

route_profile_l3_out:
    description:
    - The L3 Out that contains the associated Route Profile.
    type: str

Outputs

current:
  description: The existing configuration from the APIC after the module has finished
  returned: success
  sample:
  - fvTenant:
      attributes:
        descr: Production environment
        dn: uni/tn-production
        name: production
        nameAlias: ''
        ownerKey: ''
        ownerTag: ''
  type: list
error:
  description: The error information as returned from the APIC
  returned: failure
  sample:
    code: '122'
    text: unknown managed object class foo
  type: dict
filter_string:
  description: The filter string used for the request
  returned: failure or debug
  sample: ?rsp-prop-include=config-only
  type: str
method:
  description: The HTTP method used for the request to the APIC
  returned: failure or debug
  sample: POST
  type: str
previous:
  description: The original configuration from the APIC before the module has started
  returned: info
  sample:
  - fvTenant:
      attributes:
        descr: Production
        dn: uni/tn-production
        name: production
        nameAlias: ''
        ownerKey: ''
        ownerTag: ''
  type: list
proposed:
  description: The assembled configuration from the user-provided parameters
  returned: info
  sample:
    fvTenant:
      attributes:
        descr: Production environment
        name: production
  type: dict
raw:
  description: The raw output returned by the APIC REST API (xml or json)
  returned: parse error
  sample: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122"
    text="unknown managed object class foo"/></imdata>
  type: str
response:
  description: The HTTP response from the APIC
  returned: failure or debug
  sample: OK (30 bytes)
  type: str
sent:
  description: The actual/minimal configuration pushed to the APIC
  returned: info
  sample:
    fvTenant:
      attributes:
        descr: Production environment
  type: list
status:
  description: The HTTP status from the APIC
  returned: failure or debug
  sample: 200
  type: int
url:
  description: The HTTP url used for the request to the APIC
  returned: failure or debug
  sample: https://10.11.12.13/api/mo/uni/tn-production.json
  type: str

See also

• aci_bd
• aci_tenant
• APIC Management Information Model reference: More information about the internal APIC class B(fv:Subnet). link
• Ansible docs: Detailed information on how to manage your ACI infrastructure using Ansible. link
• Ansible docs: Detailed guide on how to write your own Cisco ACI modules to contribute. link