436 lines
25 KiB
ReStructuredText
436 lines
25 KiB
ReStructuredText
.. Document meta
|
|
|
|
:orphan:
|
|
|
|
.. Anchors
|
|
|
|
.. _ansible_collections.inspur.sm.edit_snmp_module:
|
|
|
|
.. Anchors: short name for ansible.builtin
|
|
|
|
.. Anchors: aliases
|
|
|
|
|
|
|
|
.. Title
|
|
|
|
inspur.sm.edit_snmp -- Set snmp.
|
|
++++++++++++++++++++++++++++++++
|
|
|
|
.. Collection note
|
|
|
|
.. note::
|
|
This plugin is part of the `inspur.sm collection <https://galaxy.ansible.com/inspur/sm>`_.
|
|
|
|
To install it use: :code:`ansible-galaxy collection install inspur.sm`.
|
|
|
|
To use it in a playbook, specify: :code:`inspur.sm.edit_snmp`.
|
|
|
|
.. version_added
|
|
|
|
.. versionadded:: 0.1.0 of inspur.sm
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 1
|
|
|
|
.. Deprecated
|
|
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. Description
|
|
|
|
- Set snmp on Inspur server.
|
|
|
|
.. Aliases
|
|
|
|
|
|
.. Requirements
|
|
|
|
|
|
.. Options
|
|
|
|
Parameters
|
|
----------
|
|
|
|
.. raw:: html
|
|
|
|
<table border=0 cellpadding=0 class="documentation-table">
|
|
<tr>
|
|
<th colspan="2">Parameter</th>
|
|
<th>Choices/<font color="blue">Defaults</font></th>
|
|
<th width="100%">Comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-auth_password"></div>
|
|
<b>auth_password</b>
|
|
<a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>Set auth password of V3 trap or v3get/v3set,</div>
|
|
<div>Password is a string of 8 to 16 alpha-numeric characters.</div>
|
|
<div>Required when <em>auth_protocol</em> is either <code>SHA</code> or <code>MD5</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-auth_protocol"></div>
|
|
<b>auth_protocol</b>
|
|
<a class="ansibleOptionLink" href="#parameter-auth_protocol" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>NONE</li>
|
|
<li>SHA</li>
|
|
<li>MD5</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Choose authentication of V3 trap or v3get/v3set.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-community"></div>
|
|
<b>community</b>
|
|
<a class="ansibleOptionLink" href="#parameter-community" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>Community of v1/v2c or v1get/v1set/v2cget/v2cset.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-host"></div>
|
|
<b>host</b>
|
|
<a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-password"></div>
|
|
<b>password</b>
|
|
<a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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 <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-priv_password"></div>
|
|
<b>priv_password</b>
|
|
<a class="ansibleOptionLink" href="#parameter-priv_password" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>Set privacy password of V3 trap or v3get/v3set,</div>
|
|
<div>password is a string of 8 to 16 alpha-numeric characters.</div>
|
|
<div>Required when <em>priv_protocol</em> is either <code>DES</code> or <code>AES</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-priv_protocol"></div>
|
|
<b>priv_protocol</b>
|
|
<a class="ansibleOptionLink" href="#parameter-priv_protocol" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>NONE</li>
|
|
<li>DES</li>
|
|
<li>AES</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>Choose Privacy of V3 trap or v3get/v3set.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider"></div>
|
|
<b>provider</b>
|
|
<a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">dictionary</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>A dict object containing connection details.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="elbow-placeholder"></td>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
|
|
<b>host</b>
|
|
<a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="elbow-placeholder"></td>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
|
|
<b>password</b>
|
|
<a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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 <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="elbow-placeholder"></td>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
|
|
<b>username</b>
|
|
<a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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 <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-snmp_status"></div>
|
|
<b>snmp_status</b>
|
|
<a class="ansibleOptionLink" href="#parameter-snmp_status" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">list</span>
|
|
/ <span style="color: purple">elements=string</span> </div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>NMP read/write status of customize,</div>
|
|
<div>the input parameters are 'v1get', 'v1set', 'v2cget', 'v2cset', 'v3get', 'v3set',separated by commas,such as v1get,v1set,v2cget.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-username"></div>
|
|
<b>username</b>
|
|
<a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>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 <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-v3username"></div>
|
|
<b>v3username</b>
|
|
<a class="ansibleOptionLink" href="#parameter-v3username" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
<td>
|
|
<div>Set user name of V3 trap or v3get/v3set.</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2">
|
|
<div class="ansibleOptionAnchor" id="parameter-version"></div>
|
|
<b>version</b>
|
|
<a class="ansibleOptionLink" href="#parameter-version" title="Permalink to this option"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">integer</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
<li>0</li>
|
|
<li>1</li>
|
|
<li>2</li>
|
|
<li>3</li>
|
|
<li>4</li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<div>SNMP trap version option, 0 - 'v1', 1 - 'v2c', 2 - 'v3', 3 - 'all', 4 - 'customize'.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br/>
|
|
|
|
.. Notes
|
|
|
|
|
|
.. Seealso
|
|
|
|
|
|
.. Examples
|
|
|
|
Examples
|
|
--------
|
|
|
|
.. code-block:: yaml+jinja
|
|
|
|
|
|
- name: Snmp test
|
|
hosts: ism
|
|
no_log: true
|
|
connection: local
|
|
gather_facts: no
|
|
vars:
|
|
ism:
|
|
host: "{{ ansible_ssh_host }}"
|
|
username: "{{ username }}"
|
|
password: "{{ password }}"
|
|
|
|
tasks:
|
|
|
|
- name: "Set snmp get/set"
|
|
inspur.sm.edit_snmp:
|
|
community: "test"
|
|
v3username: "Inspur"
|
|
provider: "{{ ism }}"
|
|
|
|
|
|
|
|
|
|
|
|
.. Facts
|
|
|
|
|
|
.. Return values
|
|
|
|
Return Values
|
|
-------------
|
|
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
|
|
|
|
.. raw:: html
|
|
|
|
<table border=0 cellpadding=0 class="documentation-table">
|
|
<tr>
|
|
<th colspan="1">Key</th>
|
|
<th>Returned</th>
|
|
<th width="100%">Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="return-changed"></div>
|
|
<b>changed</b>
|
|
<a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">boolean</span>
|
|
</div>
|
|
</td>
|
|
<td>always</td>
|
|
<td>
|
|
<div>Check to see if a change was made on the device.</div>
|
|
<br/>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="return-message"></div>
|
|
<b>message</b>
|
|
<a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>always</td>
|
|
<td>
|
|
<div>Messages returned after module execution.</div>
|
|
<br/>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="1">
|
|
<div class="ansibleOptionAnchor" id="return-state"></div>
|
|
<b>state</b>
|
|
<a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
|
|
<div style="font-size: small">
|
|
<span style="color: purple">string</span>
|
|
</div>
|
|
</td>
|
|
<td>always</td>
|
|
<td>
|
|
<div>Status after module execution.</div>
|
|
<br/>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br/><br/>
|
|
|
|
.. Status (Presently only deprecated)
|
|
|
|
|
|
.. Authors
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
- WangBaoshan (@ISIB-group)
|
|
|
|
|
|
|
|
.. Parsing errors
|
|
|