racampos.dnac.device_credential (0.0.1) — module

Manage DeviceCredential objects of NetworkSettings

| "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

API to get device credential details.

API to create device credentials.

API to update device credentials.

Delete device credential.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_device_credential_details
  cisco.dnac.device_credential:
    state: query  # required
    site_id: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: create_device_credentials
  cisco.dnac.device_credential:
    state: create  # required
    settings:  # required
      cliCredential:
      - description: SomeValue  # string, required
        username: SomeValue  # string, required
        password: SomeValue  # string, required
        enablePassword: SomeValue  # string
      snmpV2cRead:
      - readCommunity: SomeValue  # string, required
        description: SomeValue  # string
      snmpV2cWrite:
      - writeCommunity: SomeValue  # string, required
        description: SomeValue  # string
      snmpV3:
      - description: SomeValue  # string, required
        username: SomeValue  # string, required
        privacyType: SomeValue  # string, required
        privacyPassword: SomeValue  # string, required
        authType: SomeValue  # string, required
        snmpMode: SomeValue  # string, required
        authPassword: SomeValue  # string
      httpsRead:
      - username: SomeValue  # string, required
        password: SomeValue  # string, required
        name: SomeValue  # string
        port: 1  #  number
      httpsWrite:
      - username: SomeValue  # string, required
        password: SomeValue  # string, required
        name: SomeValue  # string
        port: 1  #  number
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: update_device_credentials
  cisco.dnac.device_credential:
    state: update  # required
    settings:  # required
      cliCredential:
        description: SomeValue  # string
        username: SomeValue  # string
        password: SomeValue  # string
        enablePassword: SomeValue  # string
        id: SomeValue  # string
      snmpV2cRead:
        description: SomeValue  # string
        readCommunity: SomeValue  # string
        id: SomeValue  # string
      snmpV2cWrite:
        description: SomeValue  # string
        writeCommunity: SomeValue  # string
        id: SomeValue  # string
      snmpV3:
        authPassword: SomeValue  # string
        authType: SomeValue  # string
        snmpMode: SomeValue  # string
        privacyPassword: SomeValue  # string
        privacyType: SomeValue  # string
        username: SomeValue  # string
        description: SomeValue  # string
        id: SomeValue  # string
      httpsRead:
        name: SomeValue  # string
        username: SomeValue  # string
        password: SomeValue  # string
        port: SomeValue  # string
        id: SomeValue  # string
      httpsWrite:
        name: SomeValue  # string
        username: SomeValue  # string
        password: SomeValue  # string
        port: SomeValue  # string
        id: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: delete_device_credential
  cisco.dnac.device_credential:
    state: delete  # required
    id: SomeValue  # string, required

Inputs

    
id:
    description:
    - Global credential id.
    - Required for state delete.
    type: str

site_id:
    description:
    - Site id to retrieve the credential details associated with the site.
    type: str

settings:
    description:
    - Settings, property of the request body.
    required: true
    suboptions:
      cliCredential:
        description:
        - It is the device credential's cliCredential.
        - Type list for state create.
        - Type dict for state update.
        type: raw
      httpsRead:
        description:
        - It is the device credential's httpsRead.
        - Type list for state create.
        - Type dict for state update.
        type: raw
      httpsWrite:
        description:
        - It is the device credential's httpsWrite.
        - Type list for state create.
        - Type dict for state update.
        type: raw
      snmpV2cRead:
        description:
        - It is the device credential's snmpV2cRead.
        - Type list for state create.
        - Type dict for state update.
        type: raw
      snmpV2cWrite:
        description:
        - It is the device credential's snmpV2cWrite.
        - Type list for state create.
        - Type dict for state update.
        type: raw
      snmpV3:
        description:
        - It is the device credential's snmpV3.
        - Type list for state create.
        - Type dict for state update.
        type: raw
    type: dict

Outputs

create_device_credentials:
  contains: null
  description: API to create device credentials.
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
delete_device_credential:
  contains: null
  description: Delete device credential.
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
get_device_credential_details:
  cli:
    contains:
      comments:
        description: It is the device credential's comments.
        returned: always
        sample: <comments>
        type: str
      credentialType:
        description: It is the device credential's credentialType.
        returned: always
        sample: <credentialtype>
        type: str
      description:
        description: It is the device credential's description.
        returned: always
        sample: <description>
        type: str
      enablePassword:
        description: It is the device credential's enablePassword.
        returned: always
        sample: <enablepassword>
        type: str
      id:
        description: It is the device credential's id.
        returned: always
        sample: '478012'
        type: str
      instanceTenantId:
        description: It is the device credential's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the device credential's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      password:
        description: It is the device credential's password.
        returned: always
        sample: '*******'
        type: str
      username:
        description: It is the device credential's username.
        returned: always
        sample: devnetuser
        type: str
    description: Cli, property of the response body (list of objects).
    returned: always
    type: list
  contains: null
  description: API to get device credential details.
  http_read:
    contains:
      comments:
        description: It is the device credential's comments.
        returned: always
        sample: <comments>
        type: str
      credentialType:
        description: It is the device credential's credentialType.
        returned: always
        sample: <credentialtype>
        type: str
      description:
        description: It is the device credential's description.
        returned: always
        sample: <description>
        type: str
      id:
        description: It is the device credential's id.
        returned: always
        sample: '478012'
        type: str
      instanceTenantId:
        description: It is the device credential's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the device credential's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      password:
        description: It is the device credential's password.
        returned: always
        sample: '*******'
        type: str
      port:
        description: It is the device credential's port.
        returned: always
        sample: <port>
        type: str
      secure:
        description: It is the device credential's secure.
        returned: always
        sample: <secure>
        type: str
      username:
        description: It is the device credential's username.
        returned: always
        sample: devnetuser
        type: str
    description: Http Read, property of the response body (list of objects).
    returned: always
    type: list
  http_write:
    contains:
      comments:
        description: It is the device credential's comments.
        returned: always
        sample: <comments>
        type: str
      credentialType:
        description: It is the device credential's credentialType.
        returned: always
        sample: <credentialtype>
        type: str
      description:
        description: It is the device credential's description.
        returned: always
        sample: <description>
        type: str
      id:
        description: It is the device credential's id.
        returned: always
        sample: '478012'
        type: str
      instanceTenantId:
        description: It is the device credential's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the device credential's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      password:
        description: It is the device credential's password.
        returned: always
        sample: '*******'
        type: str
      port:
        description: It is the device credential's port.
        returned: always
        sample: <port>
        type: str
      secure:
        description: It is the device credential's secure.
        returned: always
        sample: <secure>
        type: str
      username:
        description: It is the device credential's username.
        returned: always
        sample: devnetuser
        type: str
    description: Http Write, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  snmp_v2_read:
    contains:
      comments:
        description: It is the device credential's comments.
        returned: always
        sample: <comments>
        type: str
      credentialType:
        description: It is the device credential's credentialType.
        returned: always
        sample: <credentialtype>
        type: str
      description:
        description: It is the device credential's description.
        returned: always
        sample: <description>
        type: str
      id:
        description: It is the device credential's id.
        returned: always
        sample: '478012'
        type: str
      instanceTenantId:
        description: It is the device credential's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the device credential's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      readCommunity:
        description: It is the device credential's readCommunity.
        returned: always
        sample: <readcommunity>
        type: str
    description: Snmp V2 Read, property of the response body (list of objects).
    returned: always
    type: list
  snmp_v2_write:
    contains:
      comments:
        description: It is the device credential's comments.
        returned: always
        sample: <comments>
        type: str
      credentialType:
        description: It is the device credential's credentialType.
        returned: always
        sample: <credentialtype>
        type: str
      description:
        description: It is the device credential's description.
        returned: always
        sample: <description>
        type: str
      id:
        description: It is the device credential's id.
        returned: always
        sample: '478012'
        type: str
      instanceTenantId:
        description: It is the device credential's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the device credential's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      writeCommunity:
        description: It is the device credential's writeCommunity.
        returned: always
        sample: <writecommunity>
        type: str
    description: Snmp V2 Write, property of the response body (list of objects).
    returned: always
    type: list
  snmp_v3:
    contains:
      authPassword:
        description: It is the device credential's authPassword.
        returned: always
        sample: <authpassword>
        type: str
      authType:
        description: It is the device credential's authType.
        returned: always
        sample: <authtype>
        type: str
      comments:
        description: It is the device credential's comments.
        returned: always
        sample: <comments>
        type: str
      credentialType:
        description: It is the device credential's credentialType.
        returned: always
        sample: <credentialtype>
        type: str
      description:
        description: It is the device credential's description.
        returned: always
        sample: <description>
        type: str
      id:
        description: It is the device credential's id.
        returned: always
        sample: '478012'
        type: str
      instanceTenantId:
        description: It is the device credential's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceUuid:
        description: It is the device credential's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      privacyPassword:
        description: It is the device credential's privacyPassword.
        returned: always
        sample: <privacypassword>
        type: str
      privacyType:
        description: It is the device credential's privacyType.
        returned: always
        sample: <privacytype>
        type: str
      snmpMode:
        description: It is the device credential's snmpMode.
        returned: always
        sample: <snmpmode>
        type: str
      username:
        description: It is the device credential's username.
        returned: always
        sample: devnetuser
        type: str
    description: Snmp V3, property of the response body (list of objects).
    returned: always
    type: list
  type: dict
update_device_credentials:
  contains: null
  description: API to update device credentials.
  executionId:
    description: Execution Id, property of the response body.
    returned: changed
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: changed
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: changed
    sample: <message>
    type: str
  returned: changed
  type: dict

See also