nvidia.nvue.system (1.1.7) — module

This is the Cumulus Linux system 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 interact with the system-wide properties.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Pass in a message
- name: Display the system configuration
  nvidia.nvue.system:
    state: gathered

Inputs

    
data:
    description: Provided configuration
    suboptions:
      hostname:
        default: cumulus
        description: Static hostname for the switch.
        required: false
        type: str
      message:
        description: System pre-login and post-login messages.
        required: false
        suboptions:
          post_login:
            description: Configure post-login message of the day.
            required: false
            type: str
          pre_login:
            description: Configure pre-login banner.
            required: false
            type: str
        type: dict
      system_global:
        description: Global system configuration.
        required: false
        suboptions:
          anycast_id:
            description: An integer (1-65535) to select rack MAC address in range 44:38:39:ff:00:00
              to 44:38:39:ff:ff:ff.
            required: false
            type: int
          anycast_mac:
            description: MAC Address shared by the rack.
            required: false
            type: str
          system_mac:
            description: Full MAC Address.
            required: false
            type: str
        type: dict
      timezone:
        description: System Time Zone.
        required: false
        type: str
    type: dict

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: Revision ID to query/to apply config to.
    required: false
    type: str

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

filters:
    description: Filters used while fetching information about the system
    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
      rev:
        default: applied
        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
    type: dict