cisco.dnac.global_credential_snmpv3 (2.0.7) — module

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Adds global SNMPv3 credentials.

Updates global SNMPv3 credential.

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: create_snmpv3_credentials
  cisco.dnac.global_credential_snmpv3:
    state: create  # required
    payload:  # required
    - snmpMode: SomeValue  # string, required
      username: SomeValue  # string, required
      authPassword: SomeValue  # string
      authType: SomeValue  # string
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
      privacyPassword: SomeValue  # string
      privacyType: SomeValue  # string

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: update_snmpv3_credentials
  cisco.dnac.global_credential_snmpv3:
    state: update  # required
    snmpMode: # valid values are 'AUTHPRIV',
      # 'AUTHNOPRIV',
      # 'NOAUTHNOPRIV'.
      SomeValue  # string, required
    username: SomeValue  # string, required
    authPassword: SomeValue  # string
    authType: # valid values are 'SHA',
      # 'MD5'.
      SomeValue  # string
    comments: SomeValue  # string
    credentialType: # valid values are 'GLOBAL',
      # 'APP'.
      SomeValue  # string
    description: SomeValue  # string
    id: SomeValue  # string
    instanceTenantId: SomeValue  # string
    instanceUuid: SomeValue  # string
    privacyPassword: SomeValue  # string
    privacyType: # valid values are 'DES',
      # 'AES128'.
      SomeValue  # string

Inputs

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

payload:
    description:
    - An object to send in the Request body.
    - Required for state create.
    elements: dict
    suboptions:
      authPassword:
        description:
        - It is the global credential snmpv3's authPassword.
        type: str
      authType:
        description:
        - It is the global credential snmpv3's authType.
        type: str
      comments:
        description:
        - It is the global credential snmpv3's comments.
        type: str
      credentialType:
        description:
        - It is the global credential snmpv3's credentialType.
        type: str
      description:
        description:
        - It is the global credential snmpv3's description.
        type: str
      id:
        description:
        - It is the global credential snmpv3's id.
        type: str
      instanceTenantId:
        description:
        - It is the global credential snmpv3's instanceTenantId.
        type: str
      instanceUuid:
        description:
        - It is the global credential snmpv3's instanceUuid.
        type: str
      privacyPassword:
        description:
        - It is the global credential snmpv3's privacyPassword.
        type: str
      privacyType:
        description:
        - It is the global credential snmpv3's privacyType.
        type: str
      snmpMode:
        description:
        - It is the global credential snmpv3's snmpMode.
        required: true
        type: str
      username:
        description:
        - It is the global credential snmpv3's username.
        required: true
        type: str
    type: list

authType:
    description:
    - SNMPv3CredentialDTO's authType.
    - Available values are 'SHA' and 'MD5'.
    type: str

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

snmpMode:
    description:
    - SNMPv3CredentialDTO's snmpMode.
    - Available values are 'AUTHPRIV', 'AUTHNOPRIV' and 'NOAUTHNOPRIV'.
    - Required for state update.
    type: str

username:
    description:
    - SNMPv3CredentialDTO's username.
    - Required for state update.
    type: str

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

privacyType:
    description:
    - SNMPv3CredentialDTO's privacyType.
    - Available values are 'DES' and 'AES128'.
    type: str

authPassword:
    description:
    - SNMPv3CredentialDTO's authPassword.
    type: str

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

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

privacyPassword:
    description:
    - SNMPv3CredentialDTO's privacyPassword.
    type: str

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

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: discovery.create_snmpv3_credentials
  type: str

See also

• cisco.dnac.plugins.module_utils.definitions.global_credential_snmpv3
• GlobalCredentialSnmpv3 reference: Complete reference of the GlobalCredentialSnmpv3 object model. link
• GlobalCredentialSnmpv3 reference: SDK reference. link