cisco.dnac.service_provider (2.0.7) — module

Manage ServiceProvider objects of NetworkSettings

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

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

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_service_provider_details
  cisco.dnac.service_provider:
    state: query  # required
  register: nm_get_service_provider_details
  • 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
  • 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
  • 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

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: network_settings.create_sp_profile
  type: str

See also