ieisystem.inmanage.edit_snmp (1.1.1) — module

Set snmp

| "added in version" 1.0.0 of ieisystem.inmanage"

Authors: WangBaoshan (@ieisystem)

Install collection

Install with ansible-galaxy collection install ieisystem.inmanage:==1.1.1


Add to requirements.yml

  collections:
    - name: ieisystem.inmanage
      version: 1.1.1

Description

Set snmp on ieisystem Server.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Snmp test
  hosts: inmanage
  no_log: true
  connection: local
  gather_facts: no
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set snmp get/set"
    ieisystem.inmanage.edit_snmp:
      community: "test"
      v3username: "test"
      provider: "{{ inmanage }}"

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

version:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    description:
    - SNMP trap version option, 0 - 'v1', 1 - 'v2c', 2 - 'v3', 3 - 'all', 4 - 'customize'.
    - Only the M5 models support this feature.
    type: int

password:
    description:
    - Specifies the password to use to authenticate the connection to the remote device.
      If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
      will be used instead.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      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.
          If the value is not specified in the task, the value of environment variable
          C(ANSIBLE_NET_PASSWORD) will be used instead.
        type: str
      username:
        description:
        - Configures the username to use to authenticate the connection to the remote
          device. If the value is not specified in the task, the value of environment
          variable C(ANSIBLE_NET_USERNAME) will be used instead.
        type: str
    type: dict

username:
    description:
    - Configures the username to use to authenticate the connection to the remote device.
      If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME)
      will be used instead.
    type: str

v1status:
    choices:
    - enable
    - disable
    description:
    - SNMP V1 enable.
    type: str

v2status:
    choices:
    - enable
    - disable
    description:
    - SNMP V2 enable.
    type: str

v3status:
    choices:
    - enable
    - disable
    description:
    - SNMP V3 enable.
    type: str

community:
    description:
    - Community of v1/v2c or v1get/v1set/v2cget/v2cset.
    - Only the M5 models support this feature.
    type: str

v3username:
    description:
    - Set a username for the V3 trap or v3get/v3set.
    type: str

snmp_status:
    description:
    - NMP read/write status of customize.
    - The input parameters are 'v1get', 'v1set', 'v2cget', 'v2cset', 'v3get', 'v3set',
      separated by commas, such as v1get, v1set, v2cget.
    - Only the M5 models support this feature.
    elements: str
    type: list

auth_password:
    description:
    - Set the authentication password for the V3 trap or v3get/v3set.
    - The password is a string of 8 to 16 alphanumeric characters.
    - Required when I(auth_protocol) is either C(SHA) or C(MD5).
    type: str

auth_protocol:
    choices:
    - NONE
    - SHA
    - MD5
    description:
    - Choose the authentication protocol for the V3 trap or v3get/v3set.
    type: str

priv_password:
    description:
    - Set the privacy password for the V3 trap or v3get/v3set.
    - The password is a string of 8 to 16 alphanumeric characters.
    - Required when I(priv_protocol) is either C(DES) or C(AES).
    type: str

priv_protocol:
    choices:
    - NONE
    - DES
    - AES
    description:
    - Choose the privacy protocol for the V3 trap or v3get/v3set.
    type: str

read_community:
    description:
    - Read Only Community, Community should between 1 and 16 characters.
    - Only the M6 models support this feature.
    type: str

read_write_community:
    description:
    - Read And Write Community, Community should between 1 and 16 characters.
    - Only the M6 models support this feature.
    type: str

Outputs

changed:
  description: Check to see if a change was made on the device.
  returned: always
  type: bool
message:
  description: Messages returned after module execution.
  returned: always
  type: str
state:
  description: Status after module execution.
  returned: always
  type: str