Skip to content

Ansible Module: nokia.nsp.action

Execute actions on Nokia NSP RESTCONF resources

Notes

Requires ansible.netcommon.httpapi connection using Network OS nokia.nsp.nsp.

For global operations use nokia.nsp.rpc instead.

Resource path must URL-encode special characters properly.

Synopsis

  • Executes RESTCONF actions on Nokia NSP.
  • Uses nokia.nsp.nsp connection for client authentication.
  • Actions are bound to specific resource instances.

Parameters

Parameter Type Comments
path str Reference data resource against the action is executed.
RESTCONF compliant URI syntax must be used.
Special characters must be URL-encoded.
Namespace prefixes must be used appropriately.
Required: always
operation str Action name with optional namespace.
Required: always
input dict Input parameters for the action.
Must match YANG definition of the action.
Default: {}

Examples

- name: Audit intent configuration
  nokia.nsp.action:
    path: "ibn:ibn/intent={{ ne_id | urlencode }},{{ intent_name | urlencode }}"
    operation: audit

- name: Synchronize intent state
  nokia.nsp.action:
    path: "ibn:ibn/intent={{ ne_id | urlencode }},{{ intent_name | urlencode }}"
    operation: synchronize

Return Values

Parameter Type Comments
output dict Operation output from RESTCONF resource action
Returned: always
Sample: {"ibn:output":{"audit-report":{"intent-type":"helloworld","target":"1034::dead:beef:1"}}}
failed bool Module execution failed
Returned: always
changed bool Action caused resource change (action-dependent)
Returned: always

New in version "0.1.0"