nvidia.nvue.router (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 a Cumulus Linux module to interact with the router object.

Usage examples

Scanned by Steampunk Spotter

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

# Pass in a message
- name: Display all the router config in the environment
  nvidia.nvue.router:
    state: gathered

Inputs

    
data:
    description: Provided configuration
    suboptions:
      bgp:
        description: BGP global configuration.
        required: false
        suboptions:
          autonomous_system:
            description: ASN for all VRFs, if a single AS is in use. If "none", then ASN
              must be set for every VRF. This is the default.
            required: false
            type: int
          enable:
            choices:
            - 'on'
            - 'off'
            default: 'off'
            description: Turn the feature 'on' or 'off'.
            required: false
            type: str
          graceful_restart:
            description: BGP Graceful restart global configuration.
            required: false
            suboptions:
              mode:
                choices:
                - full
                - 'off'
                - helper-only
                default: helper-only
                description: Role of router during graceful restart. helper-only, router
                  is in helper role. full, router is in both helper and restarter role.
                  off, GR is disabled for the router
                required: false
                type: str
            type: dict
          router_id:
            description: BGP router-id for all VRFs, if a common one is used. If "none",
              then router-id must be set for every VRF. This is the default.
            required: false
            type: str
        type: dict
      ospf:
        description: OSPF global configuration.
        required: false
        suboptions:
          enable:
            choices:
            - 'on'
            - 'off'
            default: 'off'
            description: Turn the feature 'on' or 'off'.
            required: false
            type: str
          timers:
            description: Timers.
            required: false
            suboptions:
              spf:
                description: SPF timers.
                required: false
                suboptions:
                  delay:
                    description: Delay (msec) from first change received till SPF calculation.
                    required: false
                    type: int
                  holdtime:
                    description: Initial hold time (msec) between consecutive SPF calculations.
                    required: false
                    type: int
                  max_holdtime:
                    description: Maximum hold time (msec) between consecutive SPF calculations.
                    required: false
                    type: int
                type: dict
            type: dict
        type: dict
      pim:
        description: PIM global configuration.
        required: false
        suboptions:
          enable:
            choices:
            - 'on'
            - 'off'
            default: 'off'
            description: Turn the feature 'on' or 'off'.
            required: false
            type: str
          timers:
            description: Timers.
            required: false
            suboptions:
              keep_alive:
                description: Timeout value for S,G stream, in seconds.
                required: false
                type: int
            type: dict
        type: dict
      vrr:
        description: VRR global configuration.
        required: false
        suboptions:
          enable:
            choices:
            - 'on'
            - 'off'
            default: 'off'
            description: Turn the feature 'on' or 'off'.
            required: false
            type: str
        type: dict
    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 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
      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