arubanetworks.aos_switch.arubaoss_traffic_class (1.7.0) — module

implements rest api for traffic class configuration

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

Authors: Ashish Pant (@hpe)

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 apiis whcih can be used to configure trafic class

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
      - name: create traffic class
        arubaoss_traffic_class:
          class_name: my_class
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
      - name: add match criteria
        arubaoss_traffic_class:
          class_name: my_class
          icmp_code: 1
          icmp_type: 1
          source_ip_address: 0.0.0.0
          source_ip_mask: 255.255.255.255
          destination_ip_address: 0.0.0.0
          destination_ip_mask: 255.255.255.255
          protocol_type: "PT_ICMP"
          entry_type: QTCET_MATCH
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
      - name: add udp traffic ignore rule
        arubaoss_traffic_class:
          class_name: my_class
          source_ip_address: 0.0.0.0
          source_ip_mask: 255.255.255.255
          destination_ip_address: 0.0.0.0
          destination_ip_mask: 255.255.255.255
          protocol_type: "PT_UDP"
          entry_type: QTCET_IGNORE
          destination_port: {"port_not_equal": 0,
                             "port_range_start": 443,
                             "port_range_end": 443}
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
      - name: delete traffic class
        arubaoss_traffic_class:
          class_name: my_class
          state: delete

Inputs

    
tos:
    choices:
    - 0
    - 2
    - 4
    - 8
    description:
    - Tos value
    required: false

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

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

icmp_code:
    description:
    - Applies to icmp code matching this field. Only PT_ICMP protocol_type support icmp_code
    required: false

icmp_type:
    description:
    - Applies to icmp type matching this field. Only PT_ICMP protocol_type support icmp_code
    required: false

igmp_type:
    choices:
    - IT_HOST_QUERY
    - IT_HOST_REPORT
    - IT_DVMRP
    - IT_PIM
    - IT_TRACE
    - IT_V2_HOST_REPORT
    - IT_V2_HOST_LEAVE
    - IT_MTRACE_REPLY
    - IT_MTRACE_REQUEST
    - IT_V3_HOST_REPORT
    - IT_MROUTER_ADVERTISEMENT
    - IT_MROUTER_SOLICITATION
    - IT_MROUTER_TERMINATION
    description:
    - Applies to igmp type matching this field. Only PT_IGMP protocol_type support igmp_type
    required: false

match_bit:
    choices:
    - MB_ACK
    - MB_FIN
    - MB_RST
    - MB_SYN
    description:
    - The set of tcp match bits . Only PT_TCP  protocol_type support match_bit
    required: false

class_name:
    description:
    - Traffic class name
    required: true

class_type:
    choices:
    - QCT_IP_V4
    - QCT_IP_V6
    default: QCT_IP_V4
    description:
    - Traffic class type
    required: true

dscp_value:
    choices:
    - 0 - 64
    description:
    - dscp value to be applied
    required: false

entry_type:
    choices:
    - QTCET_MATCH
    - QTCET_IGNORE
    description:
    - Type of action to take.
    required: false

precedence:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    - 5
    - 6
    - 7
    description:
    - IP precedence flag
    required: false

sequece_no:
    description:
    - Sequence number for the traffic class configured
    required: false

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

      '
    type: str

device_type:
    description:
    - Applies to device type matching this extended traffic filter
    required: false

source_port:
    description:
    - Applies to source port matching this filter. Only PT_SCTP, PT_TCP and PT_UDP Protocol
      types support source_port
    required: false

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

protocol_type:
    choices:
    - PT_GRE
    - PT_ESP
    - PT_AH
    - PT_OSPF
    - PT_PIM
    - PT_VRRP
    - PT_ICMP
    - PT_IGMP
    - PT_IP
    - PT_SCTP
    - PT_TCP
    - PT_UDP
    description:
    - Protocol type for traffic filter.
    required: false

source_ip_mask:
    description:
    - Net mask source_ip_address
    required: false

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

      '
    type: bool

application_type:
    description:
    - Applies to application matching this extended traffic filter
    required: false

destination_port:
    description:
    - Applies to destination port matching this filter. Only PT_SCTP,PT_TCP and PT_UDP
      Protocol types support destination_port
    required: false

source_ip_address:
    description:
    - Applies to source IP Address/Subnet matching this extended traffic filter
    required: false

destination_ip_address:
    description:
    - Applies to destination IP Address/Subnet matching this extended traffic filter
    required: false