arubanetworks.aos_switch.arubaoss_poe (1.7.0) — module

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 PoE

Usage examples

Scanned by Steampunk Spotter

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

     - name: Updates poe port
       arubaoss_poe:
         command: config_poe_port
         port_id: 2
         is_poe_enabled: True
         poe_priority: "PPP_HIGH"
         poe_allocation_method: "PPAM_VALUE"
         allocated_power_in_watts: 15
         port_configured_type: ""
         pre_standard_detect_enabled: False

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

command:
    choices:
    - reset_poe_port
    - config_poe_port
    - config_poe_slot
    default: config_poe_port
    description: The module to be called.
    required: false

port_id:
    description: The Port id
    required: false

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

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

slot_name:
    description: The slot name
    required: false

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

poe_priority:
    choices:
    - PPP_CRITICAL
    - PPP_HIGH
    - PPP_LOW
    default: PPP_LOW
    description: The port PoE priority
    required: false

is_poe_enabled:
    description: The port PoE status
    required: false

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

      '
    type: bool

port_configured_type:
    description: Port configured type
    required: false

poe_allocation_method:
    choices:
    - PPAM_USAGE
    - PPAM_CLASS
    - PPAM_VALUE
    default: PPAM_USAGE
    description: The PoE allocation method
    required: false

allocated_power_in_watts:
    default: 1
    description: Allocated power value. Default value for this is platform dependent
    required: false

power_threshold_percentage:
    description: The power threshold percentage
    required: false

pre_standard_detect_enabled:
    default: false
    description: pre_std_detect enable or disable
    required: false