cisco.aci.aci_static_node_mgmt_address module – In band or Out of band management IP address (mgmt:RsOoBStNode and mgmt:RsInBStNode)
Note
This module is part of the cisco.aci collection (version 2.10.1).
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
Cisco ACI Fabric Node IP address
Parameters
Parameter |
Comments |
---|---|
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable If the value is not specified in the task and environment variable Default: |
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a If PEM-formatted content was provided for If the value is not specified in the task, the value of environment variable |
|
The name of the end point group |
|
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 |
|
ipv4 address of in band/out of band mgmt |
|
Gateway address of in band / out of band mgmt network |
|
ipv6 address of in band/out of band mgmt |
|
GW address of in band/out of band mgmt |
|
ACI Fabric’s node id of a leaf, spine or APIC |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
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 |
|
The password to use for authentication. This option is mutual exclusive with If the value is not specified in the task, the value of environment variables |
|
The pod number of the leaf, spine or APIC |
|
Port number to be used for REST connection. The default value depends on parameter If the value is not specified in the task, the value of environment variable |
|
Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default This option is mutual exclusive with If the value is not specified in the task, the value of environment variable |
|
Use Use Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. Choices:
|
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable The default value is 30. |
|
type of management interface Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is true when the connection is local. Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables The default value is admin. |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
See Also
See also
- APIC Management Information Model reference
More information about the internal APIC classes mgmt:RsOoBStNode and mgmt:RsInBStNode.
- 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: 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
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 |
---|---|
The existing configuration from the APIC after the module has finished Returned: success Sample: |
|
The error information as returned from the APIC Returned: failure Sample: |
|
The filter string used for the request Returned: failure or debug Sample: |
|
The HTTP method used for the request to the APIC Returned: failure or debug Sample: |
|
The original configuration from the APIC before the module has started Returned: info Sample: |
|
The assembled configuration from the user-provided parameters Returned: info Sample: |
|
The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: |
|
The HTTP response from the APIC Returned: failure or debug Sample: |
|
The actual/minimal configuration pushed to the APIC Returned: info Sample: |
|
The HTTP status from the APIC Returned: failure or debug Sample: |
|
The HTTP url used for the request to the APIC Returned: failure or debug Sample: |