You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.aci.aci_cloud_subnet module – Manage Cloud Subnet (cloud:Subnet)

Note

This module is part of the cisco.aci collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.aci.

To use it in a playbook, specify: cisco.aci.aci_cloud_subnet.

Synopsis 

Manage Cloud Subnet on Cisco Cloud ACI.

Parameters 

Parameter	Comments
address aliases: subnet string	Ip address of the Cloud Subnet.
annotation string	User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable `ACI_ANNOTATION` will be used instead. If the value is not specified in the task and environment variable `ACI_ANNOTATION` then the default value will be used. Default: `"orchestrator:ansible"`
availability_zone string	The cloud zone which is attached to the given cloud context profile. Only used when it is an aws cloud apic.
certificate_name aliases: cert_name string	The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a `private_key` filename was provided, this defaults to the `private_key` basename, without extension. If PEM-formatted content was provided for `private_key`, this defaults to the `username` value. If the value is not specified in the task, the value of environment variable `ACI_CERTIFICATE_NAME` will be used instead.
cidr string / required	Address of cloud cidr.
cloud_context_profile string / required	The name of cloud context profile.
description string	Description of the Cloud Subnet.
host aliases: hostname string / required	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 `ACI_HOST` will be used instead.
name string	The name of the Cloud Subnet.
name_alias string	An alias for the name of the current object. This relates to the nameAlias field in ACI and is used to rename object without changing the DN.
output_level string	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 If the value is not specified in the task, the value of environment variable `ACI_OUTPUT_LEVEL` will be used instead. Choices: `"debug"` `"info"` `"normal"` ← (default)
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 `ACI_OUTPUT_PATH` will be used instead.
password string	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. If the value is not specified in the task, the value of environment variables `ACI_PASSWORD` or `ANSIBLE_NET_PASSWORD` will be used instead.
port integer	Port number to be used for REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable `ACI_PORT` will be used instead.
private_key aliases: cert_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 `certificate_name` that is used. This option is mutual exclusive with `password`. If `password` is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable `ACI_PRIVATE_KEY` or `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
state string	Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects. Choices: `"absent"` `"present"` ← (default) `"query"`
tenant string / required	The name of tenant.
timeout integer	The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable `ACI_TIMEOUT` will be used instead. Default: `30`
use_proxy boolean	If `no`, 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 `ACI_USE_PROXY` will be used instead. Choices: `false` `true` ← (default)
use_ssl boolean	If `no`, 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 `ACI_USE_SSL` will be used instead. Choices: `false` `true` ← (default)
username aliases: user string	The username to use for authentication. If the value is not specified in the task, the value of environment variables `ACI_USERNAME` or `ANSIBLE_NET_USERNAME` will be used instead. Default: `"admin"`
validate_certs boolean	If `no`, SSL certificates will not be validated. This should only set to `no` when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable `ACI_VALIDATE_CERTS` will be used instead. Choices: `false` `true` ← (default)
vnet_gateway boolean	Determine if a vNet Gateway Router will be deployed or not. Only used when it is an azure cloud apic. Choices: `false` ← (default) `true`

Notes 

Note

More information about the internal APIC class cloud:Subnet from the APIC Management Information Model reference.

Examples 

- name: Create aci cloud subnet
  cisco.aci.aci_cloud_subnet:
    host: apic
    username: userName
    password: somePassword
    validate_certs: no
    tenant: anstest
    cloud_context_profile: aws_cloudCtxProfile
    cidr: '10.10.0.0/16'
    availability_zone: us-west-1a
    address: 10.10.0.1
  delegate_to: localhost

- name: Query a specific subnet
  cisco.aci.aci_cloud_subnet:
    host: apic
    username: userName
    password: somePassword
    validate_certs: no
    tenant: anstest
    cloud_context_profile: ctx_profile_1
    cidr: '10.10.0.0/16'
    address: 10.10.0.1
    state: query
  delegate_to: localhost

- name: Query all subnets
  cisco.aci.aci_cloud_subnet:
    host: apic
    username: userName
    password: somePassword
    validate_certs: no
    tenant: anstest
    cloud_context_profile: ctx_profile_1
    cidr: '10.10.0.0/16'
    state: query
  delegate_to: localhost

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
current list / elements=string	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": ""}}}]`
error dictionary	The error information as returned from the APIC Returned: failure Sample: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	The filter string used for the request Returned: failure or debug Sample: `"?rsp-prop-include=config-only"`
method string	The HTTP method used for the request to the APIC Returned: failure or debug Sample: `"POST"`
previous list / elements=string	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": ""}}}]`
proposed dictionary	The assembled configuration from the user-provided parameters Returned: info Sample: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	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>"`
response string	The HTTP response from the APIC Returned: failure or debug Sample: `"OK (30 bytes)"`
sent list / elements=string	The actual/minimal configuration pushed to the APIC Returned: info Sample: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	The HTTP status from the APIC Returned: failure or debug Sample: `200`
url string	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"`

Authors

Nirav (@nirav)
Cindy Zhao (@cizhao)

Collection links

Issue Tracker Repository (Sources)

cisco.aci.aci_cloud_subnet module – Manage Cloud Subnet (cloud:Subnet)

Synopsis

Parameters

Notes

See Also

Examples

Return Values