nvidia.nvue.bridge (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 bridges object and the properties associated with an instance of a bridge.

Usage examples

Scanned by Steampunk Spotter

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

- name: Display all the bridge domains in the environment
  nvidia.nvue.bridge:
    state: gathered

Scanned by Steampunk Spotter

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

- name: Add VLAN details to the bridge
  nvidia.nvue.bridge:
    state: merged
    force: yes
    wait: 15
    data:
        - id: 'br_default'
          type: 'vlan-aware'
          vlan:
            - id: '10'
              vni:
                - id: '10'

Inputs

    
data:
    description: Provided configuration
    elements: dict
    suboptions:
      encap:
        default: 802.1Q
        description: Interfaces added to this domain will, by default, use this encapsulation.
        required: false
        type: str
      id:
        description: Bridge domain.
        required: true
        type: str
      mac_address:
        default: auto
        description: Override global mac address.
        required: false
        type: str
      type:
        default: vlan-aware
        description: Type of bridge domain.
        required: false
        type: str
      untagged:
        description: Interfaces added to this domain will, by default, be trunk interfaces
          with a single untagged vlan. Untagged packets on domain ports will be put in
          this vlan. If none, then untagged packets will be dropped.
        required: false
        type: int
      vlan:
        description: Set of vlans in the bridge domain. Only applicable when the domain
          type is "vlan-aware".
        elements: dict
        required: false
        suboptions:
          id:
            description: A VLAN tag identifier
            required: false
            type: str
          vni:
            description: L2 VNI
            elements: dict
            required: false
            suboptions:
              flooding:
                description: Handling of BUM traffic
                required: false
                suboptions:
                  enable:
                    choices:
                    - 'on'
                    - 'off'
                    - auto
                    default: auto
                    description: Turn the feature 'on' or 'off' or 'auto'.
                    required: false
                    type: str
                  head_end_replication:
                    description: BUM traffic is replicated and individual copies sent
                      to remote destinations.
                    elements: dict
                    required: false
                    suboptions:
                      id:
                        description: An IPv4 address.
                        required: false
                        type: str
                    type: list
                  multicast_group:
                    description: BUM traffic is sent to the specified multicast group
                      and will be received by receivers who are interested in that group.
                      This usually requires PIM-SM to be used in the network.
                    required: false
                    type: str
                type: dict
              id:
                description: VNI
                required: false
                type: str
            type: list
        type: list
    type: list

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 bridge.
    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: operational
        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

domainid:
    description: Name of the domain to fetch/delete.
    required: false
    type: str

Outputs

changed:
  description: whether a configuration was changed
  returned: always
  sample: true
  type: bool
message:
  description: details of the bridge (for gathered) or whether the change was applied
    (for merged)
  returned: always
  sample:
  - br_default:
      ageing: 1800
      encap: 802.1Q
      mac-address: auto
      multicast:
        snooping:
          enable: true
          querier:
            enable: false
      stp:
        priority: 32768
        state:
          up: {}
      type: vlan-aware
      untagged: 1
      vlan:
        '1':
          multicast:
            snooping:
              querier:
                source-ip: 0.0.0.0
          ptp:
            enable: false
          vni: {}
      vlan-vni-offset: 0
  - message: Config update by cumulus
    state: applied
    transition:
      issue: {}
      progress: ''
  type: dict