piolink_yhoh.pask_test.pask_snmp (1.0.5) — module

Configuring SNMP setting

| "added in version" 2.10 of piolink_yhoh.pask_test"

Authors: Yohan Oh (@piolink-yhoh)

Install collection

Install with ansible-galaxy collection install piolink_yhoh.pask_test:==1.0.5


Add to requirements.yml

  collections:
    - name: piolink_yhoh.pask_test
      version: 1.0.5

Description

You can configure SNMP setting of the PAS-K.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: SNMP Test
  hosts: all
  connection: local
  collections:
  - piolink_yhoh.pask_test

  tasks:
  - name: Create snmp
    pask_snmp:
      prest_ip: "{{ansible_host}}"
      prest_port: "{{ansible_port}}"
      user_id: "{{user_id}}"
      user_pw: "{{user_pw}}"
      status: "enable"
      load_timeout: "65535"
      system:
        name: "Piolink"
        contact: "admin@piolink.com"
        location: "Korea"
      community:
        - { name: "piolink", policy: "read-write", limit_oid: "1.1.1.1" }
        - { name: "piolink2", policy: "read-only", limit_oid: "1.1.1.1" }
      user:
        - { name: "test1", sha_passwd: "tester123!@#"}
      trap:
        link_up: "enable"
        link_down: "disable"
        failover: "enable"
        fan: "enable"
        cold_start: "enable"
        host:
          - {ip: "2.2.2.2", version: "3", user: "piolink", engine_id: "800007E5804089071BC6D10A41", aes_passwd: "Admin123$", sha_passwd: "Admin123$"}
          - {ip: "3.3.3.3", version: "3", user: "piolink12", engine_id: "800007E5804089071BC6D10A41", aes_passwd: "Admin123$", sha_passwd: "Admin123$"}

Inputs

    
trap:
    description:
    - Enter the trap information
    suboptions:
      cold_start:
        description:
        - Enter whether to send trap when snmp enable.
        - The value should be 'enable' or 'disable'.
        type: str
      failover:
        description:
        - Enter whether to send trap when failover occur.
        - The value should be 'enable' or 'disable'.
        type: str
      fan:
        description:
        - Enter whether to send trap when cooling fan of PAS-K is shutdown.
        - The value should be 'enable' or 'diable'.
        type: str
      health_check:
        description:
        - Enter whether to send trap when health-check's result is changed
        - The value should be 'enable' or 'disable'.
        type: str
      host:
        description:
        - Enter the trap host information.
        elements: dict
        suboptions:
          aes_passwd:
            description:
            - Enter the AES passowrd for snmp version '3'.
            type: str
          community:
            description:
            - Enter the snmp community for snmp version '1' or '2c'.
            type: str
          des_passwd:
            description:
            - Enter the DES password for snmp version '3'.
            type: str
          engine_id:
            description:
            - Enter the Engine id of trap host for snmp version '3'.
            type: str
          ip:
            description:
            - Enter the ip address of the trap host.
            required: true
            type: str
          md5_passwd:
            description:
            - Enter the MD5 password for snmp version '3'.
            type: str
          sha_passwd:
            description:
            - Enter the SHA password for snmp version '3'.
            type: str
          user:
            description:
            - Enter the name of the snmp user for version '3'.
            type: str
          version:
            description:
            - Enter the trap version.
            - The value should be '1', '2c' or '3'.
            type: str
        type: list
      link_down:
        description:
        - Enter whether to send trap when interface link down.
        - The value should be 'enable' or 'disable'.
        type: str
      link_up:
        description:
        - Enter whether to send trap when interface link up.
        - The value should be 'enable' or 'disable'.
        type: str
      management_cpu:
        description:
        - Enter whether to send trap when management cpu utilization exceeds the threshold.
        - The value should be 'enable' or 'disable'.
        type: str
      management_memory:
        description:
        - Enter whether to send trap when management memory utilization exceeds the threshold.
        - The value should be 'enable' or 'disable'.
        type: str
      packet_cpu:
        description:
        - Enter whether to send trapwhen packet processor cpu utilization exceeds the
          threshold.
        - The value should be 'enable' or 'disable'.
        type: str
      packet_memory:
        description:
        - Enter whether to send trap when packet processor memory utilization exceeds
          the threshold.
        - The value should be 'enable' or 'disable'.
        type: str
      power:
        description:
        - Enter whether to send trap when PAS-K power on or power off.
        - The value should be 'enable' or 'disable'.
        type: str
      temperature:
        description:
        - Enter whether to send trap when temperature exceeds the threshold.
        - The value should be 'enable' or 'disable'.
        type: str
    type: dict

user:
    description:
    - Enter the user information for snmp version '3'.
    elements: dict
    suboptions:
      aes_passwd:
        description:
        - Enter the AES passowrd.
        type: str
      des_passwd:
        description:
        - Enter the DES password.
        type: str
      md5_passwd:
        description:
        - Enter the MD5 password.
        type: str
      name:
        description:
        - Enter the snmp user name.
        required: true
        type: str
      sha_passwd:
        description:
        - Enter the SHA passowrd.
        type: str
    type: list

status:
    description:
    - Enter whether to use snmp.
    - The value should be 'enable' or 'disable'.
    type: str

system:
    description:
    - Enter the PAS-K information for snmp.
    suboptions:
      contact:
        description:
        - Enter the contact information.
        - ex) email, telephone.
        type: str
      location:
        description:
        - Enter the location of the PAS-K.
        type: str
      name:
        description:
        - Enter the name of the PAS-K.
        type: str
    type: dict

user_id:
    description:
    - Enter the PAS-K user id.
    required: true
    type: str

user_pw:
    description:
    - Enter the PAS-K user password.
    required: true
    type: str

prest_ip:
    description:
    - Enter the PAS-K IP address.
    required: true
    type: str

community:
    description:
    - Enter the snmp community information.
    elements: dict
    suboptions:
      limit_oid:
        description:
        - Enter the oid accessible by using the community.
        type: str
      name:
        description:
        - Enther the name of the commnunity for snmp version '1' or '2c'.
        required: true
        type: str
      policy:
        description:
        - Enter the policy of the commnunity.
        - The value should be 'read-only' or 'read-write'.
        type: str
    type: list

prest_port:
    description:
    - Enter the port number of PAS-K used for PREST-API.
    required: true
    type: str

load_timeout:
    description:
    - Enter the load-timeout for snmp.
    type: str