.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.nfv_profile_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.nfv_profile -- Manage NfvProfile objects of SiteDesign +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.nfv_profile`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - API to create network profile for different NFV topologies. - API to get NFV network profile. - API to delete nfv network profile. - API to update a NFV Network profile. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
device
list / elements=dictionary / required
Device, property of the request body (list of objects).
currentDeviceTag
string / required
It is the nfv profile's currentDeviceTag.
customNetworks
list / elements=dictionary
It is the nfv profile's customNetworks.
connectionType
string
It is the nfv profile's connectionType.
Required for states update and create.
networkName
string
It is the nfv profile's networkName.
Required for states update and create.
servicesToConnect
list / elements=dictionary / required
It is the nfv profile's servicesToConnect.
serviceName
string
It is the nfv profile's serviceName.
Required for states update and create.
vlanId
integer
It is the nfv profile's vlanId.
Required for states update and create.
vlanMode
string
It is the nfv profile's vlanMode.
Required for states update and create.
customTemplate
list / elements=dictionary
It is the nfv profile's customTemplate.
deviceType
string
It is the nfv profile's deviceType.
Required for states update and create.
template
string
It is the nfv profile's template.
Required for states update and create.
templateType
string
It is the nfv profile's templateType.
Required for states update and create.
deviceTag
string
It is the nfv profile's deviceTag.
Required for states update and create.
deviceType
string / required
It is the nfv profile's deviceType.
directInternetAccessForFirewall
boolean
    Choices:
  • no
  • yes
It is the nfv profile's directInternetAccessForFirewall.
Required for states update and create.
serviceProviderProfile
list / elements=dictionary / required
It is the nfv profile's serviceProviderProfile.
connect
boolean / required
    Choices:
  • no
  • yes
It is the nfv profile's connect.
connectDefaultGatewayOnWan
boolean / required
    Choices:
  • no
  • yes
It is the nfv profile's connectDefaultGatewayOnWan.
linkType
string / required
It is the nfv profile's linkType.
serviceProvider
string / required
It is the nfv profile's serviceProvider.
services
list / elements=dictionary / required
It is the nfv profile's services.
firewallMode
string
It is the nfv profile's firewallMode.
imageName
string
It is the nfv profile's imageName.
Required for states update and create.
profileType
string
It is the nfv profile's profileType.
Required for states update and create.
serviceName
string
It is the nfv profile's serviceName.
Required for states update and create.
serviceType
string
It is the nfv profile's serviceType.
Required for states update and create.
vNicMapping
list / elements=dictionary / required
It is the nfv profile's vNicMapping.
assignIpAddressToNetwork
string
It is the nfv profile's assignIpAddressToNetwork.
networkType
string
It is the nfv profile's networkType.
Required for states update and create.
vlanForL2
list / elements=dictionary
It is the nfv profile's vlanForL2.
vlanDescription
string
It is the nfv profile's vlanDescription.
Required for states update and create.
vlanId
integer
It is the nfv profile's vlanId.
Required for states update and create.
vlanType
string
It is the nfv profile's vlanType.
Required for states update and create.
id
string / required
ID of network profile to retrieve.
Id of nfv network profile to delete. .
Id of the NFV profile to be updated.
limit
string
Number of profile to be retrieved.
name
string
Name of network profile to be retrieved.
Nameof nfv network profile to delete. .
Name of the profile to be updated.
offset
string
Offset/starting row.
profileName
string
Site Profile Name, property of the request body.
Required for state create.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.dnac.plugins.module_utils.definitions.nfv_profile ` The official documentation on the **cisco.dnac.plugins.module_utils.definitions.nfv_profile** module. `NfvProfile reference `_ Complete reference of the NfvProfile object model. `NfvProfile reference `_ SDK reference. .. Examples Examples -------- .. code-block:: yaml+jinja - name: create_nfv_profile cisco.dnac.nfv_profile: state: create # required device: # required - deviceType: SomeValue # string, required deviceTag: SomeValue # string, required serviceProviderProfile: # required - serviceProvider: SomeValue # string, required linkType: SomeValue # string, required connect: True # boolean, required connectDefaultGatewayOnWan: True # boolean, required directInternetAccessForFirewall: True # boolean, required services: # required - serviceType: SomeValue # string, required profileType: SomeValue # string, required serviceName: SomeValue # string, required imageName: SomeValue # string, required vNicMapping: # required - networkType: SomeValue # string, required assignIpAddressToNetwork: SomeValue # string firewallMode: SomeValue # string customNetworks: - networkName: SomeValue # string, required servicesToConnect: # required - serviceName: SomeValue # string, required connectionType: SomeValue # string, required vlanMode: SomeValue # string, required vlanId: 1 # number, required vlanForL2: - vlanType: SomeValue # string, required vlanId: 1 # number, required vlanDescription: SomeValue # string, required customTemplate: - deviceType: SomeValue # string, required template: SomeValue # string, required templateType: SomeValue # string, required profileName: SomeValue # string, required - name: get_nfv_profile cisco.dnac.nfv_profile: state: query # required id: SomeValue # string, required limit: SomeValue # string name: SomeValue # string offset: SomeValue # string register: nm_get_nfv_profile - name: delete_nfv_profile cisco.dnac.nfv_profile: state: delete # required id: SomeValue # string, required name: SomeValue # string - name: update_nfv_profile cisco.dnac.nfv_profile: state: update # required id: SomeValue # string, required device: # required - deviceTag: SomeValue # string, required directInternetAccessForFirewall: True # boolean, required currentDeviceTag: SomeValue # string, required services: - serviceType: SomeValue # string, required profileType: SomeValue # string, required serviceName: SomeValue # string, required imageName: SomeValue # string, required vNicMapping: # required - networkType: SomeValue # string, required assignIpAddressToNetwork: SomeValue # string firewallMode: SomeValue # string customNetworks: - networkName: SomeValue # string, required servicesToConnect: # required - serviceName: SomeValue # string, required connectionType: SomeValue # string, required vlanMode: SomeValue # string, required vlanId: 1 # number, required vlanForL2: - vlanType: SomeValue # string, required vlanId: 1 # number, required vlanDescription: SomeValue # string, required customTemplate: - deviceType: SomeValue # string, required template: SomeValue # string, required templateType: SomeValue # string, required name: SomeValue # string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
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:
site_design.create_nfv_profile


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors