kaytus.ksmanage.edit_snmp module – Set snmp
Note
This module is part of the kaytus.ksmanage collection (version 1.2.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install kaytus.ksmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: kaytus.ksmanage.edit_snmp
.
New in kaytus.ksmanage 1.0.0
Synopsis
Set snmp on kaytus Server.
Requirements
The below requirements are needed on the host that executes this module.
Python 3.7+
inManage
Parameters
Parameter |
Comments |
---|---|
Set the authentication password for the V3 trap or v3get/v3set. The password is a string of 8 to 16 alphanumeric characters. Required when auth_protocol is either |
|
Choose the authentication protocol for the V3 trap or v3get/v3set. Choices:
|
|
Community of v1/v2c or v1get/v1set/v2cget/v2cset. Only the M5 models support this feature. |
|
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. |
|
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 |
|
Set the privacy password for the V3 trap or v3get/v3set. The password is a string of 8 to 16 alphanumeric characters. Required when priv_protocol is either |
|
Choose the privacy protocol for the V3 trap or v3get/v3set. Choices:
|
|
A dict object containing connection details. |
|
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. |
|
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 |
|
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 |
|
Read Only Community, Community should between 1 and 16 characters. Only the M6 models support this feature. |
|
Read And Write Community, Community should between 1 and 16 characters. Only the M6 models support this feature. |
|
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. |
|
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 |
|
SNMP V1 enable. Choices:
|
|
SNMP V2 enable. Choices:
|
|
SNMP V3 enable. Choices:
|
|
Set a username for the V3 trap or v3get/v3set. |
|
SNMP trap version option, 0 - ‘v1’, 1 - ‘v2c’, 2 - ‘v3’, 3 - ‘all’, 4 - ‘customize’. Only the M5 models support this feature. Choices:
|
Notes
Note
Does not support
check_mode
.
Examples
- name: Snmp test
hosts: ksmanage
no_log: true
connection: local
gather_facts: false
vars:
ksmanage:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Set snmp get/set"
kaytus.ksmanage.edit_snmp:
community: "test"
v3username: "test"
provider: "{{ ksmanage }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Check to see if a change was made on the device. Returned: always |
|
Messages returned after module execution. Returned: always |
|
Status after module execution. Returned: always |