/ home / ansible / ansible.builtin / v2.5.10 / module / nso_action

ansible.builtin.nso_action (v2.5.10) — module

Executes Cisco NSO actions and verifies output.

| "added in version" 2.5 of ansible.builtin"

Authors: Claes Nästén (@cnasten)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.5.10

Description

This module provices support for executing Cisco NSO actions and then verifying that the output is as expected.

Requirements

Cisco NSO version 4.4.3 or higher.

Usage examples

Scanned by Steampunk Spotter

- name: Sync NSO device
  nso_config:
    url: http://localhost:8080/jsonrpc
    username: username
    password: password
    path: /ncs:devices/device{ce0}/sync-from
    output_required:
      result: true

Inputs

    
url:
    description: NSO JSON-RPC URL, http://localhost:8080/jsonrpc
    required: true
    type: str

path:
    description: Path to NSO action.
    required: true

input:
    description: 'NSO action parameters.

      '

timeout:
    default: 300
    description: JSON-RPC request timeout in seconds
    type: int

password:
    description: NSO password
    required: true
    type: str

username:
    description: NSO username
    required: true
    type: str

output_invalid:
    description: 'List of result parameter names that will cause the task to fail if they
      are present.

      '

validate_certs:
    default: false
    description: When set to true, validates the SSL certificate of NSO when using SSL
    required: false
    type: bool

output_required:
    description: 'Required output parameters.

      '

validate_strict:
    description: 'If set to true, the task will fail if any output parameters not in output_required
      is present in the output.

      '

Outputs

output:
  description: Action output
  returned: success
  sample:
    result: true
  type: dict

Install Ansible via pip