nvidia.nvue.api (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 connection plugin provides a connection to NVUE over an HTTP(S)-based api.

Usage examples

Scanned by Steampunk Spotter

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

# In-line data definition
- name: Example of interpolating variables
  nvidia.nvue.api:
    operation: set
    force: yes
    wait: 15
    data:
      system:
        message:
          "pre-login": "{{ MSG }}"
  vars:
    MSG: WARNING

Scanned by Steampunk Spotter

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

# Using inventory variables
- name: Example of using host variables
  nvidia.nvue.api:
    operation: set
    force: yes
    wait: 15
    data: "{{ dict(host_variables) }}"

Inputs

    
data:
    default: {}
    description: Structured data used with "set" operations.
    required: false
    type: dict

path:
    default: /
    description: API path that will be appended to "/nvue_v1"
    required: false
    type: str

wait:
    default: 0
    description: How long to poll for "set" operation results.
    required: false
    type: int

force:
    default: false
    description: When true, replies "yes" to NVUE prompts.
    required: false
    type: bool

revid:
    description: Revision ID to query/to apply config to
    required: false
    type: str

filled:
    default: true
    description: If true, fill in attributes with default values, providing a complete
      set of attributes. If false, return only the attributes that differ from the defaults.
    required: false
    type: bool

operation:
    choices:
    - get
    - set
    default: get
    description: Type of API operation
    required: false
    type: str

Outputs

changed:
  description: whether a configuration was changed
  returned: always
  sample: true
  type: bool
message:
  description: whether a change was applied
  returned: always
  sample:
    state: applied
  type: dict