cisco.mso.ndo_tenant_netflow_monitor module – Manage NetFlow Monitor on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 3.0.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_tenant_netflow_monitor.

New in cisco.mso 3.0.0

Synopsis

• Manage NetFlow Monitor on Cisco Nexus Dashboard Orchestrator (NDO).

• This module is only supported on ND v4.1 (NDO v5.1) 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 NetFlow Monitor. Defaults to an empty string when unset during creation.
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 string	The name of the NetFlow Monitor.
netflow_exporters list / elements=dictionary	The list of NetFlow Exporter references. At least one reference is required when the state is present. The old netflow_exporters list will be replaced by the new list during an update.
reference aliases: ref dictionary	The reference of the NetFlow Exporter. This parameter or netflow_exporters.uuid is required.
name string / required	The name of the NetFlow Exporter.
template string	The template associated with the NetFlow Exporter. This parameter or netflow_exporters.reference.template_id is required.
template_id string	The template ID associated with the NetFlow Exporter. This parameter or netflow_exporters.reference.template is required.
uuid string	The UUID of the NetFlow Exporter. This parameter or netflow_exporters.reference is required.
netflow_record dictionary	The NetFlow Record reference details for the NetFlow Monitor. Providing an empty dictionary netflow_record={} will remove NetFlow Record from the NetFlow Monitor.
reference aliases: ref dictionary	The reference details of the NetFlow Record. This parameter can be used instead of netflow_record.uuid.
name string / required	The name of the NetFlow Record.
template string	The template associated with the NetFlow Record. This parameter or netflow_record.reference.template_id is required.
template_id string	The template ID associated with the NetFlow Record. This parameter or netflow_record.reference.template is required.
uuid string	The UUID of the NetFlow Record. This parameter can be used instead of netflow_record.reference.
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 tenant template. This parameter or template_id is required.
template_id string	The ID of the tenant 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 string	The UUID of the NetFlow Monitor. 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 must exist before using this module in your playbook. Use cisco.mso.ndo_template to create the Tenant template.

• The netflow_record must exist before using it with this module in your playbook. Use cisco.mso.ndo_tenant_netflow_record to create the NetFlow Record.

• The netflow_exporters must exist before using this module in your playbook. Use cisco.mso.ndo_tenant_netflow_exporter to create the NetFlow Exporter.

• 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_tenant_netflow_record

Manage NetFlow Record on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_tenant_netflow_exporter

Manage NetFlow Exporter on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Add a NetFlow Monitor
  cisco.mso.ndo_tenant_netflow_monitor:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: netflow_monitor_1
    description: NetFlow Monitor for testing
    netflow_record:
      reference:
        name: netflow_record_1
        template: ansible_tenant_template
    netflow_exporters:
      - reference:
          name: netflow_exporter_1
          template: ansible_tenant_template
    state: present
  register: add_netflow_monitor

- name: Update a NetFlow Monitor name using UUID
  cisco.mso.ndo_tenant_netflow_monitor:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: netflow_monitor_1_updated
    uuid: "{{ add_netflow_monitor.current.uuid }}"
    netflow_exporters:
      - reference:
          name: netflow_exporter_1
          template: ansible_tenant_template
      - uuid: "{{ add_netflow_exporter_2.current.uuid }}"
    state: present

- name: Query a NetFlow Monitor using name
  cisco.mso.ndo_tenant_netflow_monitor:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: netflow_monitor_1_updated
    state: query
  register: query_one_with_name

- name: Query a NetFlow Monitor using UUID
  cisco.mso.ndo_tenant_netflow_monitor:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ add_netflow_monitor.current.uuid }}"
    state: query
  register: query_one_with_uuid

- name: Query all NetFlow Monitors
  cisco.mso.ndo_tenant_netflow_monitor:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    state: query
  register: query_all

- name: Remove a NetFlow Monitor using name
  cisco.mso.ndo_tenant_netflow_monitor:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: netflow_monitor_1_updated
    state: absent

- name: Remove a NetFlow Monitor using UUID
  cisco.mso.ndo_tenant_netflow_monitor:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ add_netflow_monitor.current.uuid }}"
    state: absent

Authors

• Sabari Jaganathan (@sajagana)

• Samita Bhattacharjee (@samiib)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)