arubanetworks.aos_switch.arubaoss_sntp (1.7.0) — module

implements rest api for sntp and sntp server priority configuration

| "added in version" 2.4.0 of arubanetworks.aos_switch"

Authors: Naveen Prabhu S D (sd.naveen-prabhu@hpe.com)

preview | supported by community

Install collection

Install with ansible-galaxy collection install arubanetworks.aos_switch:==1.7.0


Add to requirements.yml

  collections:
    - name: arubanetworks.aos_switch
      version: 1.7.0

Description

This implements rest apis which can be used to configure sntp

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
      - name: config sntp server priority
        arubaoss_sntp:
          command: config_sntp_priority
          sntp_ip_address: "2.2.3.4"
          version: "IAV_IP_V4"
          sntp_server_priority: 3
          sntp_server_version : 5
          sntp_server_is_oobm : true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
      - name: Delete sntp server priority
        arubaoss_sntp:
          config: "delete"
          command: config_sntp_priority
          sntp_ip_address: "2.2.3.4"
          version: "IAV_IP_V4"
          sntp_server_priority: 3
          sntp_server_version : 5
          sntp_server_is_oobm : true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
      - name: disable sntp
        arubaoss_sntp:
          command: config_sntp
          sntp_client_operation_mode: SNTP_DISABLE
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
      - name: configure sntp poll interval 44 in Unicast
        arubaoss_sntp:
          sntp_config_poll_interval: 44
          sntp_client_operation_mode: "SNTP_UNICAST_MODE"
          command: config_sntp

Inputs

    
host:
    description: 'Specifies the DNS host name or address for connecting to the remote
      device over the specified transport. The value of host is used as the destination
      address for the transport.

      '
    type: str

port:
    description: 'Specifies the port to use when building the connection to the remote
      device.

      '
    type: int

config:
    choices:
    - create
    - delete
    default: create
    description: To config, unconfig the required command
    required: true

command:
    choices:
    - config_sntp
    - config_sntp_priority
    description: Name of sub module, according to the configuration required.
    required: true

timeout:
    description: 'Specifies the timeout in seconds for communicating with the network
      device for either connecting or sending commands. If the timeout is exceeded before
      the operation is completed, the module will error.

      '
    type: int

use_ssl:
    description: 'Configures use SSL (HTTPS) for access to the remote device.

      '
    type: bool

version:
    choices:
    - IAV_IP_V4
    default: IAV_IP_V4
    description: Version of IP Address (V6 is not supported via REST)
    required: true

password:
    description: 'Specifies the password to use to authenticate the connection to the
      remote device. This value is used to authenticate the SSH session. If the value
      is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD
      will be used instead.

      '
    type: str

provider:
    description: A dict object containing connection details.
    suboptions:
      api_version:
        default: None
        description: 'Configures (force) API version (vX.Y) for acces to the remote device.

          '
        type: str
      host:
        description: 'Specifies the DNS host name or address for connecting to the remote
          device over the specified transport. The value of host is used as the destination
          address for the transport.

          '
        type: str
      password:
        description: 'Specifies the password to use to authenticate the connection to
          the remote device. This value is used to authenticate the SSH session. If the
          value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD
          will be used instead.

          '
        type: str
      port:
        description: 'Specifies the port to use when building the connection to the remote
          device.

          '
        type: int
      ssh_keyfile:
        description: 'Specifies the SSH key to use to authenticate the connection to the
          remote device. This value is the path to the key used to authenticate the SSH
          session. If the value is not specified in the task, the value of environment
          variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

          '
        type: path
      timeout:
        description: 'Specifies the timeout in seconds for communicating with the network
          device for either connecting or sending commands. If the timeout is exceeded
          before the operation is completed, the module will error.

          '
        type: int
      transport:
        default: aossapi
        description: 'Configures the transport (aossapi or network_cli) mode.

          '
        type: str
      use_proxy:
        default: false
        description: 'Configures use (Local) Proxy for access to the remote device.

          '
        type: bool
      use_ssl:
        description: 'Configures use SSL (HTTPS) for access to the remote device.

          '
        type: bool
      username:
        description: 'Configures the username to use to authenticate the connection to
          the remote device. This value is used to authenticate the SSH session. If the
          value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME
          will be used instead.

          '
        type: str
      validate_certs:
        default: false
        description: 'Configures validation of certification for access to the remote
          device.

          '
        type: bool
    type: dict

username:
    description: 'Configures the username to use to authenticate the connection to the
      remote device. This value is used to authenticate the SSH session. If the value
      is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME
      will be used instead.

      '
    type: str

api_version:
    default: None
    description: 'Configures (force) API version (vX.Y) for acces to the remote device.

      '
    type: str

ssh_keyfile:
    description: 'Specifies the SSH key to use to authenticate the connection to the remote
      device. This value is the path to the key used to authenticate the SSH session.
      If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE
      will be used instead.

      '
    type: path

validate_certs:
    default: false
    description: 'Configures validation of certification for access to the remote device.

      '
    type: bool

sntp_ip_address:
    description: IP Address to be configured on sntp server priority
    required: true

sntp_server_is_oobm:
    default: false
    description: Use the OOBM interface to connect to the server
    required: false

sntp_server_version:
    default: 7
    description: SNTP version of server.
    required: false

sntp_server_priority:
    description: Priority of Server Address.
    required: true

sntp_config_poll_interval:
    description: The number of seconds between updates of the system clock using SNTP.
    required: false

sntp_client_operation_mode:
    choices:
    - SNTP_DISABLE
    - SNTP_DHCP_MODE
    - SNTP_UNICAST_MODE
    - SNTP_BROADCAST_MODE
    default: SNTP_DHCP_MODE
    description: The mode in which clients are sending packets to SNTP server.
    required: false