nvidia.nvue.command (1.1.7) — module

Install collection

Install with ansible-galaxy collection install nvidia.nvue:==1.1.7

Add to requirements.yml

  collections:
    - name: nvidia.nvue
      version: 1.1.7

Description

This is my longer description explaining my test module.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Pass in a single command
- name: Set system pre-login message
  nvidia.nvue.command:
    commands:
    - set system message pre-login "{{ MSG }}"
    atomic: true
    assume_yes: true
  vars:
    MSG: WARNING

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Using command templating
- name: Set prefix lists
  nvidia.nvue.command:
    template: |
      {% for rule in rules %}
      set router policy prefix-list PL rule {{ rule.id }} match {{ rule.match }}
      set router policy prefix-list PL rule {{ rule.id }} action {{ rule.action }}
      {% endfor %}
    apply: true
    assume_yes: true
  vars:
    rules:
    - id: 10
      match: 1.1.1.1/32
      action: permit
    - id: 20
      match: 8.8.8.8/32
      action: deny

Inputs

    
msg:
    description: Add message to apply
    required: false
    type: str

save:
    default: false
    description: Saves NVUE configuration to disk
    required: false
    type: bool

apply:
    default: false
    description: When true, performs a "nvue apply" at the end of the block.
    required: false
    type: bool

atomic:
    default: false
    description: When true, equivalent to both `apply` and `detach` being true.
    required: false
    type: bool

detach:
    default: false
    description: When true, performs `nv config detach` before this block.
    required: false
    type: bool

commands:
    description: A list of strings containing the net commands to run.
    elements: str
    required: false
    type: list

template:
    description: A single, multi-line string with jinja2 formatting. This string will
      be broken and executed by lines.
    required: false
    type: str

assume_yes:
    default: false
    description: When true, adds a "-y" flag to the "nvue apply" command.
    required: false
    type: bool

Outputs

changed:
  description: whether a configuration was changed
  returned: always
  sample: true
  type: bool
message:
  description: a message returned from the supplied NVUE commands
  returned: always
  sample: 'Failed on line "set system m123ssage pre-login "WARNING""

    Invalid Command: set system m123ssage pre-login WARNING

    '
  type: str