racampos.dnac.global_credential_snmpv2_read_community (0.0.1) — module

Manage GlobalCredentialSnmpv2ReadCommunity objects of Discovery

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

Adds global SNMP read community.

Updates global SNMP read community.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create_snmp_read_community
  cisco.dnac.global_credential_snmpv2_read_community:
    state: create  # required
    payload:  # required
    - readCommunity: SomeValue  # string, required
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: update_snmp_read_community
  cisco.dnac.global_credential_snmpv2_read_community:
    state: update  # required
    readCommunity: SomeValue  # string, required
    comments: SomeValue  # string
    credentialType: SomeValue  # string, valid values: 'GLOBAL', 'APP'.
    description: SomeValue  # string
    id: SomeValue  # string
    instanceTenantId: SomeValue  # string
    instanceUuid: SomeValue  # string

Inputs

    
id:
    description:
    - SNMPv2ReadCommunityDTO's id.
    type: str

payload:
    description:
    - An object to send in the Request body.
    - Required for state create.
    elements: dict
    suboptions:
      comments:
        description:
        - It is the global credential snmpv2 read community's comments.
        type: str
      credentialType:
        description:
        - It is the global credential snmpv2 read community's credentialType.
        type: str
      description:
        description:
        - It is the global credential snmpv2 read community's description.
        type: str
      id:
        description:
        - It is the global credential snmpv2 read community's id.
        type: str
      instanceTenantId:
        description:
        - It is the global credential snmpv2 read community's instanceTenantId.
        type: str
      instanceUuid:
        description:
        - It is the global credential snmpv2 read community's instanceUuid.
        type: str
      readCommunity:
        description:
        - It is the global credential snmpv2 read community's readCommunity.
        required: true
        type: str
    type: list

comments:
    description:
    - SNMPv2ReadCommunityDTO's comments.
    type: str

description:
    description:
    - SNMPv2ReadCommunityDTO's description.
    type: str

instanceUuid:
    description:
    - SNMPv2ReadCommunityDTO's instanceUuid.
    type: str

readCommunity:
    description:
    - SNMPv2ReadCommunityDTO's readCommunity.
    - Required for state update.
    type: str

credentialType:
    description:
    - SNMPv2ReadCommunityDTO's credentialType.
    - Available values are 'GLOBAL' and 'APP'.
    type: str

instanceTenantId:
    description:
    - SNMPv2ReadCommunityDTO's instanceTenantId.
    type: str

Outputs

create_snmp_read_community:
  contains: null
  description: Adds global SNMP read community.
  response:
    contains:
      taskId:
        description: It is the global credential snmpv2 read community's taskId.
        returned: success
        type: dict
      url:
        description: It is the global credential snmpv2 read community's url.
        returned: success
        sample: <url>
        type: str
    description: SNMPv2ReadCommunityDTO's response.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: SNMPv2ReadCommunityDTO's version.
    returned: success
    sample: '1.0'
    type: str
update_snmp_read_community:
  contains: null
  description: Updates global SNMP read community.
  response:
    contains:
      taskId:
        description: It is the global credential snmpv2 read community's taskId.
        returned: changed
        type: dict
      url:
        description: It is the global credential snmpv2 read community's url.
        returned: changed
        sample: <url>
        type: str
    description: SNMPv2ReadCommunityDTO's response.
    returned: changed
    type: dict
  returned: changed
  type: dict
  version:
    description: SNMPv2ReadCommunityDTO's version.
    returned: changed
    sample: '1.0'
    type: str

See also