Join AnsibleFest at Red Hat Summit!

You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the latest (stable) released version.

cisco.mso.ndo_node_profile module – Manage Node Profiles on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.10.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.mso. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.mso.ndo_node_profile.

Synopsis

• Manage Node Profiles on Cisco Nexus Dashboard Orchestrator (NDO).

• This module is only supported on ND v3.1 (NDO v4.3) and later.

Requirements

The below requirements are needed on the host that executes this module.

• Multi Site Orchestrator v2.1 or newer

Parameters

Parameter	Comments
description string	The description of the Node Profile.
host aliases: hostname string	IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable MSO_HOST will be used instead.
login_domain string	The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable MSO_LOGIN_DOMAIN will be used instead. When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_login_domain will be used if this attribute is not specified.
name aliases: node_profile string	The name of the Node Profile.
node_setting dictionary	The node setting to associate with the Node Profile. This parameter or node_setting_uuid is required when state=present.
name string / required	The name of the node setting.
template string	The name of the fabric policy template that contains the node setting. This parameter or node_setting.template_id is required.
template_id string	The ID of the fabric policy template that contains the node setting. This parameter or node_setting.template is required.
node_setting_uuid string	The UUID of the node setting to associate with the Node Profile. This parameter or node_setting is required when state=present.
nodes list / elements=string	The list of node IDs to associate with the Node Profile. Each element can either be a single node ID or a range of IDs. This parameter is required when state=present.
output_level string	Influence the output of this MSO 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 MSO_OUTPUT_LEVEL will be used instead. Choices: "debug" "info" "normal" ← (default)
password string	The password to use for authentication. If the value is not specified in the task, the value of environment variables MSO_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
port integer	Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable MSO_PORT will be used instead.
state string	Use absent for removing. Use query for listing an object or multiple objects. Use present for creating or updating. Choices: "absent" "query" ← (default) "present"
template string	The name of the template. The template must be a Fabric Resource Policy template. This parameter or template_id is required.
template_id string	The ID of the template. The template must be a Fabric Resource Policy template. This parameter or template is required.
timeout integer	The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable MSO_TIMEOUT will be used instead.
use_proxy boolean	If false, 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 MSO_USE_PROXY will be used instead. The default is true. Choices: false true
use_ssl boolean	If false, 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 MSO_USE_SSL will be used instead. When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified. The default is false when using a HTTPAPI connection plugin (mso or nd) and true when using the legacy connection method (only for mso). Choices: false true
username string	The username to use for authentication. If the value is not specified in the task, the value of environment variables MSO_USERNAME or ANSIBLE_NET_USERNAME will be used instead.
uuid aliases: node_profile_uuid string	The UUID of the Node Profile. This parameter is required when the name needs to be updated.
validate_certs boolean	If false, SSL certificates will not be validated. This should only set to false when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead. The default is true. Choices: false true

Notes

Note

• The template and node_setting must exist before using this module in your playbook. Use cisco.mso.ndo_template to create the Fabric Resource Policy template. Use cisco.mso.ndo_node_setting to create the Node Setting.

• This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

See Also

See also

cisco.mso.ndo_template

Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_node_setting

Manage Fabric Policy Node Settings on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Create a new Node Profile
  cisco.mso.ndo_node_profile:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_resource_template
    name: node_profile_1
    nodes: [101, 102, 103-105]
    node_setting:
      name: node_setting_1
      template: fabric_template
    state: present
  register: create_node_profile_1

- name: Update the name and Node Setting of a Node Policy using UUID
  cisco.mso.ndo_node_profile:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: "{{ create_fabric_resource.current.templateId }}"
    name: node_profile_1_updated
    nodes: [101, 102, 103-105]
    node_setting_uuid: "{{ create_node_setting_2.current.uuid }}"
    state: present
  register: update_node_profile_1

- name: Query an existing Node Profile using UUID
  cisco.mso.ndo_node_profile:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_resource_template
    uuid: "{{ create_node_profile_1.current.uuid }}"
    state: query
  register: query_with_uuid

- name: Query an existing Node Profile using name
  cisco.mso.ndo_node_profile:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_resource_template
    name: node_profile_1_updated
    state: query
  register: query_with_name

- name: Query all Node Profiles
  cisco.mso.ndo_node_profile:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_resource_template
    state: query
  register: query_all

- name: Delete an existing Node Profile using UUID
  cisco.mso.ndo_node_profile:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_resource_template
    uuid: "{{ create_node_profile_1.current.uuid }}"
    state: absent

- name: Delete an existing Node Profile using Name
  cisco.mso.ndo_node_profile:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_resource_template
    name: node_profile_1_updated
    state: absent

Authors

• Samita Bhattacharjee (@samiib)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)