racampos.dnac.service_provider (0.0.1) — module

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 service provider details (QoS).

API to create service provider profile(QOS).

API to update SP profile.

API to delete Service Provider profile (QoS).

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

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

- name: get_service_provider_details
  cisco.dnac.service_provider:
    state: query  # required

  register: query_result

Scanned by Steampunk Spotter

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

  
- name: create_sp_profile
  cisco.dnac.service_provider:
    state: create  # required
    settings:  # required
      qos:
      - profileName: SomeValue  # string, required
        model: SomeValue  # string, required
        wanProvider: SomeValue  # string, required

Scanned by Steampunk Spotter

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

  
- name: update_sp_profile
  cisco.dnac.service_provider:
    state: update  # required
    settings:  # required
      qos:
      - oldProfileName: SomeValue  # string, required
        profileName: SomeValue  # string
        model: SomeValue  # string
        wanProvider: SomeValue  # string

Scanned by Steampunk Spotter

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

  
- name: delete_sp_profile
  cisco.dnac.service_provider:
    state: delete  # required
    sp_profile_name: SomeValue  # string, required

Inputs

    
settings:
    description:
    - Settings, property of the request body.
    required: true
    suboptions:
      qos:
        description:
        - It is the service provider's qos.
        elements: dict
        suboptions:
          model:
            description:
            - It is the service provider's model.
            - Required for state create.
            type: str
          oldProfileName:
            description:
            - It is the service provider's oldProfileName.
            required: true
            type: str
          profileName:
            description:
            - It is the service provider's profileName.
            - Required for state create.
            type: str
          wanProvider:
            description:
            - It is the service provider's wanProvider.
            - Required for state create.
            type: str
        type: list
    type: dict

sp_profile_name:
    description:
    - Sp profile name.
    - Required for state delete.
    type: str

Outputs

create_sp_profile:
  contains: null
  description: API to create service provider profile(QOS).
  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_sp_profile:
  contains: null
  description: API to delete Service Provider profile (QoS).
  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_service_provider_details:
  contains: null
  description: API to get service provider details (QoS).
  response:
    contains:
      groupUuid:
        description: It is the service provider's groupUuid.
        returned: always
        sample: <groupuuid>
        type: str
      inheritedGroupName:
        description: It is the service provider's inheritedGroupName.
        returned: always
        sample: <inheritedgroupname>
        type: str
      inheritedGroupUuid:
        description: It is the service provider's inheritedGroupUuid.
        returned: always
        sample: <inheritedgroupuuid>
        type: str
      instanceType:
        description: It is the service provider's instanceType.
        returned: always
        sample: <instancetype>
        type: str
      instanceUuid:
        description: It is the service provider's instanceUuid.
        returned: always
        sample: <instanceuuid>
        type: str
      key:
        description: It is the service provider's key.
        returned: always
        sample: <key>
        type: str
      namespace:
        description: It is the service provider's namespace.
        returned: always
        sample: <namespace>
        type: str
      type:
        description: It is the service provider's type.
        returned: always
        sample: <type>
        type: str
      value:
        contains:
          slaProfileName:
            description: It is the service provider's slaProfileName.
            returned: always
            sample: <slaprofilename>
            type: str
          spProfileName:
            description: It is the service provider's spProfileName.
            returned: always
            sample: <spprofilename>
            type: str
          wanProvider:
            description: It is the service provider's wanProvider.
            returned: always
            sample: <wanprovider>
            type: str
        description: It is the service provider's value.
        returned: always
        type: list
      version:
        description: It is the service provider's version.
        returned: always
        sample: '1.0'
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
update_sp_profile:
  contains: null
  description: API to update SP profile.
  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

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