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_static_node_mgmt_address module – In band or Out of band management IP address

Note

This module is part of the cisco.aci collection (version 2.2.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_static_node_mgmt_address.

Synopsis
Parameters
See Also
Examples
Return Values

Synopsis 

Cisco ACI Fabric Node IP address

Parameters 

Parameter	Comments
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.
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.
epg string	The name of the end point group
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.
ipv4_address aliases: ip string	ipv4 address of in band/out of band mgmt
ipv4_gw aliases: gw string	Gateway address of in band / out of band mgmt network
ipv6_address aliases: ipv6 string	ipv6 address of in band/out of band mgmt
ipv6_gw string	GW address of in band/out of band mgmt
node_id integer	ACI Fabric’s node id of a leaf, spine or APIC
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.
pod_id integer	The pod number of the leaf, spine or APIC
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
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
type string / required	type of management interface Choices: in_band out_of_band
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: no yes ← (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: no yes ← (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: no yes ← (default)

Examples 

- name: Add ipv4 address to in band mgmt interface
  cisco.aci.aci_static_node_mgmt_address:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    epg: default
    pod_id: 1
    type: in_band
    node_id: 1102
    ipv4_address: "3.1.1.2/24"
    ipv4_gw: "3.1.1.1"
    state: present
  delegate_to: localhost

- name: Add ipv4 address to out of band mgmt interface
  cisco.aci.aci_static_node_mgmt_address:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    epg: default
    pod_id: 1
    band_type: out_of_band
    node_id: 1102
    ipv4_address: "3.1.1.2/24"
    ipv4_gw: "3.1.1.1"
    state: present
  delegate_to: localhost

- name: Remove ipv4 address to in band mgmt interface
  cisco.aci.aci_static_node_mgmt_address:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    epg: default
    pod_id: 1
    type: in_band
    node_id: 1102
    ipv4_address: "3.1.1.2/24"
    ipv4_gw: "3.1.1.1"
    state: absent
  delegate_to: localhost

- name: Query the in band mgmt ipv4 address
  cisco.aci.aci_static_node_mgmt_address:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    epg: default
    pod_id: 1
    type: in_band
    node_id: 1102
    ipv4_address: "3.1.1.2/24"
    ipv4_gw: "3.1.1.1"
    state: query
  delegate_to: localhost

- name: Query all addresses in epg out of band25wf
  cisco.aci.aci_static_node_mgmt_address:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    epg: default
    type: out_of_band
    state: query
  delegate_to: localhost

- name: Query all in band addresses
  cisco.aci.aci_static_node_mgmt_address:
    host: "Host IP"
    username: admin
    password: SomeSecretePassword
    type: in_band
    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: “\u003c?xml version=\”1.0\” encoding=\”UTF-8\”?\u003e\u003cimdata totalCount=\”1\”\u003e\u003cerror code=\”122\” text=\”unknown managed object class \”/\u003e\u003c/imdata\u003e”
response string	The HTTP response from the APIC Returned: failure or debug Sample: “class_map (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

Sudhakar Shet Kudtarkar (@kudtarkar1)
Lionel Hercot (@lhercot)
Shreyas Srish (@shrsr)

Collection links

Issue Tracker Repository (Sources)

cisco.aci.aci_static_node_mgmt_address module – In band or Out of band management IP address

Synopsis

Parameters

See Also

Examples

Return Values