/ home / nvidia / nvidia.nvue / 1.1.7 / module / config

nvidia.nvue.config (1.1.7) — module

This is a Cumulus Linux revision module

| "added in version" 1.0.0 of nvidia.nvue"

Authors: Nvidia NBU Team (@nvidia-nbu), Krishna Vasudevan (@krisvasudevan)

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 a Cumulus Linux module to initialize/apply a revision.

Usage examples

Scanned by Steampunk Spotter

- name: Fetch all revisions
  nvidia.nvue.config:
    state: gathered

Scanned by Steampunk Spotter

- name: Fetch specific revision
  nvidia.nvue.config:
    state: gathered
    revid: changeset/cumulus/2021-11-02_16.09.18_5Z1K

Scanned by Steampunk Spotter

- name: Initialize a revision
  nvidia.nvue.config:
    state: new

Scanned by Steampunk Spotter

- name: Apply a revision
  nvidia.nvue.config:
    state: apply
    revid: changeset/cumulus/2021-11-02_16.09.18_5Z1K

Inputs

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

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

revid:
    description: The default is to query the operational state. However, this parameter
      can be used to query desired state on configuration branches, such as startup and
      applied. This could be a branch name, tag name or specific commit.
    required: false
    type: str

state:
    choices:
    - gathered
    - new
    - apply
    description: Defines the action to be taken.
    required: true
    type: str

filters:
    description: Filters used while fetching information about router
    suboptions:
      include:
        description: Only include JSON properties matched by an include pattern in the
          response.
        elements: str
        required: false
        type: list
      omit:
        description: Drop any JSON properties matched by an omit pattern from the response.
        elements: str
        required: false
        type: list
    type: dict