cisco.dnac.service_provider – Manage ServiceProvider objects of NetworkSettings

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.service_provider.

New in version 1.0.0: of cisco.dnac

Synopsis

• 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).

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk

Parameters

Parameter			Choices/Defaults	Comments
settings dictionary / required				Settings, property of the request body.
	qos list / elements=dictionary			It is the service provider's qos.
		model string		It is the service provider's model. Required for state create.
		oldProfileName string / required		It is the service provider's oldProfileName.
		profileName string		It is the service provider's profileName. Required for state create.
		wanProvider string		It is the service provider's wanProvider. Required for state create.
sp_profile_name string				Sp profile name. Required for state delete.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.service_provider

The official documentation on the cisco.dnac.plugins.module_utils.definitions.service_provider module.

ServiceProvider reference

Complete reference of the ServiceProvider object model.

ServiceProvider reference

SDK reference.

Examples

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

- 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

- 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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: network_settings.create_sp_profile

Authors

• Rafael Campos (@racampos)