nvidia.nvue.service (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 services 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 services in the environment
  nvidia.nvue.service:
    state: gathered

Inputs

    
data:
    description: Provided configuration
    suboptions:
      dhcp_relay:
        description: Config of DHCP relay service.
        elements: dict
        required: false
        suboptions:
          gateway_interface:
            description: Configures DHCP relay gateway on the interfaes.
            elements: dict
            required: false
            suboptions:
              address:
                default: auto
                description: ipv4 address on gateway interface.
                required: false
                type: str
              id:
                description: An interface on which DHCP relay gateway is configured.
                required: false
                type: str
            type: list
          id:
            description: DHCP-relay.
            required: false
            type: str
          interface:
            description: Set of interfaces on which to handle DHCP relay traffic.
            elements: dict
            required: false
            suboptions:
              id:
                description: An interface on which DHCP relay is configured.
                required: false
                type: str
            type: list
          server:
            description: DHCP servers.
            elements: dict
            required: false
            suboptions:
              id:
                description: A dhcp server.
                required: false
                type: str
            type: list
          source_ip:
            default: auto
            description: Source IP to use on the relayed packet. If "giaddr", it will
              be taken from giaddress. Otherwise, if "auto", it will be taken from an
              L3 interface on this switch using normal routing methods. This is the default.
            required: false
            type: str
        type: list
      dns:
        description: Collection of DNS.
        elements: dict
        required: false
        suboptions:
          id:
            description: VRF name.
            required: false
            type: str
          server:
            description: Remote DNS servers.
            elements: dict
            required: false
            suboptions:
              id:
                description: Remote DNS Server.
                required: false
                type: str
            type: list
        type: list
      ntp:
        description: Collection of NTPs.
        elements: dict
        required: false
        suboptions:
          id:
            description: VRF name.
            required: false
            type: str
          server:
            description: Remote NTP servers.
            elements: dict
            required: false
            suboptions:
              iburst:
                choices:
                - 'on'
                - 'off'
                default: 'on'
                description: When the server is unreachable, send a burst of eight packets
                  instead of the usual one.
                required: false
                type: str
              id:
                description: Remote NTP Server.
                required: false
                type: str
            type: list
        type: list
      snmp_server:
        description: SNMP configuration
        elements: dict
        required: false
        suboptions:
          enable:
            choices:
            - 'on'
            - 'off'
            default: 'off'
            description: Turn the feature on or off. The feature is disabled by default.
            required: false
            type: str
          listening_address:
            description: Collection of listening addresses.
            elements: dict
            required: false
            suboptions:
              id:
                description: A listening address.
                required: false
                type: str
              vrf:
                description: The listening address VRF.
                required: false
                type: str
            type: list
          readonly_community:
            description: Collection of readonly community string passwords for version
              1 or 2c access for IPv4.
            elements: dict
            required: false
            suboptions:
              access:
                description: Assign addresses to readonly community string password.
                elements: dict
                required: false
                suboptions:
                  id:
                    description: An address for readonly community string password.
                    required: false
                    type: str
                  oid:
                    description: An object identifier (OID) that represents a managed
                      object in the MIB hierarchy.
                    required: false
                    type: str
                  view:
                    description: A name of a view that restricts MIB tree exposure.
                    required: false
                    type: str
                type: list
              id:
                description: A readonly community string password for version 1 or 2c
                  access for IPv4.
                required: false
                type: str
            type: list
          system_contact:
            description: SNMP server system contact info.
            required: false
            type: str
          system_location:
            description: SNMP server system location info.
            required: false
            type: str
        type: list
      syslog:
        description: Collection of syslog.
        elements: dict
        required: false
        suboptions:
          id:
            description: VRF name.
            required: false
            type: str
          server:
            description: Remote syslog servers.
            elements: dict
            required: false
            suboptions:
              id:
                description: Remote syslog server.
                required: false
                type: str
              port:
                default: 514
                description: Port number of the remote syslog server.
                required: false
                type: int
              protocol:
                choices:
                - udp
                - tcp
                default: udp
                description: Protocol, udp or tcp, of the remote syslog server.
                required: false
                type: str
            type: list
        type: list
    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 services
    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