racampos.dnac.pnp_settings (0.0.1) — module

Manage PnpSettings objects of DeviceOnboardingPnp

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

Returns global PnP settings of the user.

Updates the user's list of global PnP settings.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_pnp_global_settings
  cisco.dnac.pnp_settings:
    state: query  # required

  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: update_pnp_global_settings
  cisco.dnac.pnp_settings:
    state: update  # required
    _id: SomeValue  # string
    aaaCredentials:
      password: SomeValue  # string
      username: SomeValue  # string
    acceptEula: True  # boolean
    defaultProfile:
      cert: SomeValue  # string
      fqdnAddresses:
      - SomeValue  # string
      ipAddresses:
      - SomeValue  # string
      port: 1  #  integer
      proxy: True  # boolean
    savaMappingList:
    - profile:  # required
        addressFqdn: SomeValue  # string
        addressIpV4: SomeValue  # string
        cert: SomeValue  # string
        makeDefault: True  # boolean
        name: SomeValue  # string
        port: 1  #  integer
        profileId: SomeValue  # string
        proxy: True  # boolean
      smartAccountId: SomeValue  # string, required
      syncStatus: SomeValue  # string, required
      virtualAccountId: SomeValue  # string, required
      autoSyncPeriod: 1  #  integer
      ccoUser: SomeValue  # string
      expiry: 1  #  integer
      lastSync: 1  #  integer
      syncResult:
        syncList:
        - deviceSnList:
          - SomeValue  # string
          syncType: SomeValue  # string
        syncMsg: SomeValue  # string
      syncResultStr: SomeValue  # string
      syncStartTime: 1  #  integer
      tenantId: SomeValue  # string
      token: SomeValue  # string
    taskTimeOuts:
      configTimeOut: 1  #  integer
      generalTimeOut: 1  #  integer
      imageDownloadTimeOut: 1  #  integer
    tenantId: SomeValue  # string
    version: 1  #  integer

Inputs

    
_id:
    description:
    - Settings's _id.
    type: str

version:
    description:
    - Settings's version.
    type: int

tenantId:
    description:
    - Settings's tenantId.
    type: str

acceptEula:
    description:
    - Settings's acceptEula.
    type: bool

taskTimeOuts:
    description:
    - Settings's taskTimeOuts.
    suboptions:
      configTimeOut:
        description:
        - It is the pnp settings's configTimeOut.
        type: int
      generalTimeOut:
        description:
        - It is the pnp settings's generalTimeOut.
        type: int
      imageDownloadTimeOut:
        description:
        - It is the pnp settings's imageDownloadTimeOut.
        type: int
    type: dict

aaaCredentials:
    description:
    - Settings's aaaCredentials.
    suboptions:
      password:
        description:
        - It is the pnp settings's password.
        type: str
      username:
        description:
        - It is the pnp settings's username.
        type: str
    type: dict

defaultProfile:
    description:
    - Settings's defaultProfile.
    suboptions:
      cert:
        description:
        - It is the pnp settings's cert.
        type: str
      fqdnAddresses:
        description:
        - It is the pnp settings's fqdnAddresses.
        type: list
      ipAddresses:
        description:
        - It is the pnp settings's ipAddresses.
        type: list
      port:
        description:
        - It is the pnp settings's port.
        type: int
      proxy:
        description:
        - It is the pnp settings's proxy.
        type: bool
    type: dict

savaMappingList:
    description:
    - Settings's savaMappingList (list of objects).
    elements: dict
    suboptions:
      autoSyncPeriod:
        description:
        - It is the pnp settings's autoSyncPeriod.
        type: int
      ccoUser:
        description:
        - It is the pnp settings's ccoUser.
        type: str
      expiry:
        description:
        - It is the pnp settings's expiry.
        type: int
      lastSync:
        description:
        - It is the pnp settings's lastSync.
        type: int
      profile:
        description:
        - It is the pnp settings's profile.
        required: true
        suboptions:
          addressFqdn:
            description:
            - It is the pnp settings's addressFqdn.
            type: str
          addressIpV4:
            description:
            - It is the pnp settings's addressIpV4.
            type: str
          cert:
            description:
            - It is the pnp settings's cert.
            type: str
          makeDefault:
            description:
            - It is the pnp settings's makeDefault.
            type: bool
          name:
            description:
            - It is the pnp settings's name.
            type: str
          port:
            description:
            - It is the pnp settings's port.
            type: int
          profileId:
            description:
            - It is the pnp settings's profileId.
            type: str
          proxy:
            description:
            - It is the pnp settings's proxy.
            type: bool
        type: dict
      smartAccountId:
        description:
        - It is the pnp settings's smartAccountId.
        required: true
        type: str
      syncResult:
        description:
        - It is the pnp settings's syncResult.
        suboptions:
          syncList:
            description:
            - It is the pnp settings's syncList.
            elements: dict
            suboptions:
              deviceSnList:
                description:
                - It is the pnp settings's deviceSnList.
                type: list
              syncType:
                description:
                - It is the pnp settings's syncType.
                type: str
            type: list
          syncMsg:
            description:
            - It is the pnp settings's syncMsg.
            type: str
        type: dict
      syncResultStr:
        description:
        - It is the pnp settings's syncResultStr.
        type: str
      syncStartTime:
        description:
        - It is the pnp settings's syncStartTime.
        type: int
      syncStatus:
        description:
        - It is the pnp settings's syncStatus.
        required: true
        type: str
      tenantId:
        description:
        - It is the pnp settings's tenantId.
        type: str
      token:
        description:
        - It is the pnp settings's token.
        type: str
      virtualAccountId:
        description:
        - It is the pnp settings's virtualAccountId.
        required: true
        type: str
    type: list

Outputs

get_pnp_global_settings:
  _id:
    description: Id, property of the response body.
    returned: always
    sample: <_id>
    type: str
  aaaCredentials:
    contains:
      password:
        description: It is the pnp settings's password.
        returned: always
        sample: '*******'
        type: str
      username:
        description: It is the pnp settings's username.
        returned: always
        sample: devnetuser
        type: str
    description: Aaa Credentials, property of the response body.
    returned: always
    type: dict
  acceptEula:
    description: AcceptEula, property of the response body.
    returned: always
    sample: false
    type: bool
  contains: null
  defaultProfile:
    contains:
      cert:
        description: It is the pnp settings's cert.
        returned: always
        sample: <cert>
        type: str
      fqdnAddresses:
        description: It is the pnp settings's fqdnAddresses.
        returned: always
        type: list
      ipAddresses:
        description: It is the pnp settings's ipAddresses.
        returned: always
        type: list
      port:
        description: It is the pnp settings's port.
        returned: always
        sample: 0
        type: int
      proxy:
        description: It is the pnp settings's proxy.
        returned: always
        sample: false
        type: bool
    description: Default Profile, property of the response body.
    returned: always
    type: dict
  description: Returns global PnP settings of the user.
  id:
    description: Id, property of the response body.
    returned: always
    sample: '478012'
    type: str
  returned: always
  savaMappingList:
    contains:
      autoSyncPeriod:
        description: It is the pnp settings's autoSyncPeriod.
        returned: always
        sample: 0
        type: int
      ccoUser:
        description: It is the pnp settings's ccoUser.
        returned: always
        sample: <ccouser>
        type: str
      expiry:
        description: It is the pnp settings's expiry.
        returned: always
        sample: 0
        type: int
      lastSync:
        description: It is the pnp settings's lastSync.
        returned: always
        sample: 0
        type: int
      profile:
        contains:
          addressFqdn:
            description: It is the pnp settings's addressFqdn.
            returned: always
            sample: <addressfqdn>
            type: str
          addressIpV4:
            description: It is the pnp settings's addressIpV4.
            returned: always
            sample: <addressipv4>
            type: str
          cert:
            description: It is the pnp settings's cert.
            returned: always
            sample: <cert>
            type: str
          makeDefault:
            description: It is the pnp settings's makeDefault.
            returned: always
            sample: false
            type: bool
          name:
            description: It is the pnp settings's name.
            returned: always
            sample: <name>
            type: str
          port:
            description: It is the pnp settings's port.
            returned: always
            sample: 0
            type: int
          profileId:
            description: It is the pnp settings's profileId.
            returned: always
            sample: <profileid>
            type: str
          proxy:
            description: It is the pnp settings's proxy.
            returned: always
            sample: false
            type: bool
        description: It is the pnp settings's profile.
        returned: always
        type: dict
      smartAccountId:
        description: It is the pnp settings's smartAccountId.
        returned: always
        sample: <smartaccountid>
        type: str
      syncResult:
        contains:
          syncList:
            contains:
              deviceSnList:
                description: It is the pnp settings's deviceSnList.
                returned: always
                type: list
              syncType:
                description: It is the pnp settings's syncType.
                returned: always
                sample: <synctype>
                type: str
            description: It is the pnp settings's syncList.
            returned: always
            type: list
          syncMsg:
            description: It is the pnp settings's syncMsg.
            returned: always
            sample: <syncmsg>
            type: str
        description: It is the pnp settings's syncResult.
        returned: always
        type: dict
      syncResultStr:
        description: It is the pnp settings's syncResultStr.
        returned: always
        sample: <syncresultstr>
        type: str
      syncStartTime:
        description: It is the pnp settings's syncStartTime.
        returned: always
        sample: 0
        type: int
      syncStatus:
        description: It is the pnp settings's syncStatus.
        returned: always
        sample: <syncstatus>
        type: str
      tenantId:
        description: It is the pnp settings's tenantId.
        returned: always
        sample: <tenantid>
        type: str
      token:
        description: It is the pnp settings's token.
        returned: always
        sample: <token>
        type: str
      virtualAccountId:
        description: It is the pnp settings's virtualAccountId.
        returned: always
        sample: <virtualaccountid>
        type: str
    description: Sava Mapping List, property of the response body (list of objects).
    returned: always
    type: list
  taskTimeOuts:
    contains:
      configTimeOut:
        description: It is the pnp settings's configTimeOut.
        returned: always
        sample: 0
        type: int
      generalTimeOut:
        description: It is the pnp settings's generalTimeOut.
        returned: always
        sample: 0
        type: int
      imageDownloadTimeOut:
        description: It is the pnp settings's imageDownloadTimeOut.
        returned: always
        sample: 0
        type: int
    description: Task Time Outs, property of the response body.
    returned: always
    type: dict
  tenantId:
    description: Tenant Id, property of the response body.
    returned: always
    sample: <tenantid>
    type: str
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: 0
    type: int
update_pnp_global_settings:
  _id:
    description: Settings's Id.
    returned: changed
    sample: <_id>
    type: str
  aaaCredentials:
    contains:
      password:
        description: It is the pnp settings's password.
        returned: changed
        sample: '*******'
        type: str
      username:
        description: It is the pnp settings's username.
        returned: changed
        sample: devnetuser
        type: str
    description: Settings's Aaa Credentials.
    returned: changed
    type: dict
  acceptEula:
    description: Settings's acceptEula.
    returned: changed
    sample: false
    type: bool
  contains: null
  defaultProfile:
    contains:
      cert:
        description: It is the pnp settings's cert.
        returned: changed
        sample: <cert>
        type: str
      fqdnAddresses:
        description: It is the pnp settings's fqdnAddresses.
        returned: changed
        type: list
      ipAddresses:
        description: It is the pnp settings's ipAddresses.
        returned: changed
        type: list
      port:
        description: It is the pnp settings's port.
        returned: changed
        sample: 0
        type: int
      proxy:
        description: It is the pnp settings's proxy.
        returned: changed
        sample: false
        type: bool
    description: Settings's Default Profile.
    returned: changed
    type: dict
  description: Updates the user's list of global PnP settings.
  id:
    description: Settings's Id.
    returned: changed
    sample: '478012'
    type: str
  returned: changed
  savaMappingList:
    contains:
      autoSyncPeriod:
        description: It is the pnp settings's autoSyncPeriod.
        returned: changed
        sample: 0
        type: int
      ccoUser:
        description: It is the pnp settings's ccoUser.
        returned: changed
        sample: <ccouser>
        type: str
      expiry:
        description: It is the pnp settings's expiry.
        returned: changed
        sample: 0
        type: int
      lastSync:
        description: It is the pnp settings's lastSync.
        returned: changed
        sample: 0
        type: int
      profile:
        contains:
          addressFqdn:
            description: It is the pnp settings's addressFqdn.
            returned: changed
            sample: <addressfqdn>
            type: str
          addressIpV4:
            description: It is the pnp settings's addressIpV4.
            returned: changed
            sample: <addressipv4>
            type: str
          cert:
            description: It is the pnp settings's cert.
            returned: changed
            sample: <cert>
            type: str
          makeDefault:
            description: It is the pnp settings's makeDefault.
            returned: changed
            sample: false
            type: bool
          name:
            description: It is the pnp settings's name.
            returned: changed
            sample: <name>
            type: str
          port:
            description: It is the pnp settings's port.
            returned: changed
            sample: 0
            type: int
          profileId:
            description: It is the pnp settings's profileId.
            returned: changed
            sample: <profileid>
            type: str
          proxy:
            description: It is the pnp settings's proxy.
            returned: changed
            sample: false
            type: bool
        description: It is the pnp settings's profile.
        returned: changed
        type: dict
      smartAccountId:
        description: It is the pnp settings's smartAccountId.
        returned: changed
        sample: <smartaccountid>
        type: str
      syncResult:
        contains:
          syncList:
            contains:
              deviceSnList:
                description: It is the pnp settings's deviceSnList.
                returned: changed
                type: list
              syncType:
                description: It is the pnp settings's syncType.
                returned: changed
                sample: <synctype>
                type: str
            description: It is the pnp settings's syncList.
            returned: changed
            type: list
          syncMsg:
            description: It is the pnp settings's syncMsg.
            returned: changed
            sample: <syncmsg>
            type: str
        description: It is the pnp settings's syncResult.
        returned: changed
        type: dict
      syncResultStr:
        description: It is the pnp settings's syncResultStr.
        returned: changed
        sample: <syncresultstr>
        type: str
      syncStartTime:
        description: It is the pnp settings's syncStartTime.
        returned: changed
        sample: 0
        type: int
      syncStatus:
        description: It is the pnp settings's syncStatus.
        returned: changed
        sample: <syncstatus>
        type: str
      tenantId:
        description: It is the pnp settings's tenantId.
        returned: changed
        sample: <tenantid>
        type: str
      token:
        description: It is the pnp settings's token.
        returned: changed
        sample: <token>
        type: str
      virtualAccountId:
        description: It is the pnp settings's virtualAccountId.
        returned: changed
        sample: <virtualaccountid>
        type: str
    description: Settings's Sava Mapping List (list of objects).
    returned: changed
    type: list
  taskTimeOuts:
    contains:
      configTimeOut:
        description: It is the pnp settings's configTimeOut.
        returned: changed
        sample: 0
        type: int
      generalTimeOut:
        description: It is the pnp settings's generalTimeOut.
        returned: changed
        sample: 0
        type: int
      imageDownloadTimeOut:
        description: It is the pnp settings's imageDownloadTimeOut.
        returned: changed
        sample: 0
        type: int
    description: Settings's Task Time Outs.
    returned: changed
    type: dict
  tenantId:
    description: Settings's Tenant Id.
    returned: changed
    sample: <tenantid>
    type: str
  type: dict
  version:
    description: Settings's version.
    returned: changed
    sample: 0
    type: int

See also