.. Document meta
:orphan:
.. Anchors
.. _ansible_collections.cisco.dnac.nfv_profile_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.nfv_profile -- Resource module for Nfv Profile
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 3.1.2).
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
- Manage operations create, update and delete of the resource Nfv Profile.
.. note::
This module has a corresponding :ref:`action plugin <action_plugins>`.
.. Aliases
.. Requirements
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk
.. Options
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="4">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="4">
<div class="ansibleOptionAnchor" id="parameter-device"></div>
<b>device</b>
<a class="ansibleOptionLink" href="#parameter-device" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Nfv Profile's device.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-device/customNetworks"></div>
<b>customNetworks</b>
<a class="ansibleOptionLink" href="#parameter-device/customNetworks" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Nfv Profile's customNetworks.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/customNetworks/connectionType"></div>
<b>connectionType</b>
<a class="ansibleOptionLink" href="#parameter-device/customNetworks/connectionType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Type of network connection from custom network (eg lan).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/customNetworks/networkName"></div>
<b>networkName</b>
<a class="ansibleOptionLink" href="#parameter-device/customNetworks/networkName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name of custom network (eg cust-1).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/customNetworks/servicesToConnect"></div>
<b>servicesToConnect</b>
<a class="ansibleOptionLink" href="#parameter-device/customNetworks/servicesToConnect" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Nfv Profile's servicesToConnect.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-device/customNetworks/servicesToConnect/serviceName"></div>
<b>serviceName</b>
<a class="ansibleOptionLink" href="#parameter-device/customNetworks/servicesToConnect/serviceName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name of service to be connected to the custom network (eg router-1).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/customNetworks/vlanId"></div>
<b>vlanId</b>
<a class="ansibleOptionLink" href="#parameter-device/customNetworks/vlanId" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Vlan id for the custom network(eg 4000).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/customNetworks/vlanMode"></div>
<b>vlanMode</b>
<a class="ansibleOptionLink" href="#parameter-device/customNetworks/vlanMode" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Network mode (eg Access or Trunk).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-device/customTemplate"></div>
<b>customTemplate</b>
<a class="ansibleOptionLink" href="#parameter-device/customTemplate" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Nfv Profile's customTemplate.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/customTemplate/deviceType"></div>
<b>deviceType</b>
<a class="ansibleOptionLink" href="#parameter-device/customTemplate/deviceType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Type of the device(eg Cisco 5400 Enterprise Network Compute System).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/customTemplate/template"></div>
<b>template</b>
<a class="ansibleOptionLink" href="#parameter-device/customTemplate/template" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name of the template(eg NFVIS template).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/customTemplate/templateType"></div>
<b>templateType</b>
<a class="ansibleOptionLink" href="#parameter-device/customTemplate/templateType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name of the template type to which template is associated (eg Cloud DayN Templates).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-device/deviceTag"></div>
<b>deviceTag</b>
<a class="ansibleOptionLink" href="#parameter-device/deviceTag" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Device Tag name(eg dev1).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-device/deviceType"></div>
<b>deviceType</b>
<a class="ansibleOptionLink" href="#parameter-device/deviceType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name of the device used in creating nfv profile.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-device/directInternetAccessForFirewall"></div>
<b>directInternetAccessForFirewall</b>
<a class="ansibleOptionLink" href="#parameter-device/directInternetAccessForFirewall" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Direct internet access value should be boolean (eg false or true).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-device/serviceProviderProfile"></div>
<b>serviceProviderProfile</b>
<a class="ansibleOptionLink" href="#parameter-device/serviceProviderProfile" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Nfv Profile's serviceProviderProfile.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/serviceProviderProfile/connect"></div>
<b>connect</b>
<a class="ansibleOptionLink" href="#parameter-device/serviceProviderProfile/connect" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Connection of service provider and device value should be boolean (eg true).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/serviceProviderProfile/connectDefaultGatewayOnWan"></div>
<b>connectDefaultGatewayOnWan</b>
<a class="ansibleOptionLink" href="#parameter-device/serviceProviderProfile/connectDefaultGatewayOnWan" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Connect default gateway connect value as boolean (eg true).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/serviceProviderProfile/linkType"></div>
<b>linkType</b>
<a class="ansibleOptionLink" href="#parameter-device/serviceProviderProfile/linkType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name of connection type(eg GigabitEthernet).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/serviceProviderProfile/serviceProvider"></div>
<b>serviceProvider</b>
<a class="ansibleOptionLink" href="#parameter-device/serviceProviderProfile/serviceProvider" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name of the service provider(eg Airtel).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-device/services"></div>
<b>services</b>
<a class="ansibleOptionLink" href="#parameter-device/services" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Nfv Profile's services.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/services/firewallMode"></div>
<b>firewallMode</b>
<a class="ansibleOptionLink" href="#parameter-device/services/firewallMode" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Firewall mode details example (routed, transparent).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/services/imageName"></div>
<b>imageName</b>
<a class="ansibleOptionLink" href="#parameter-device/services/imageName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Service image name (eg isrv-universalk9.16.12.01a.tar.gz).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/services/profileType"></div>
<b>profileType</b>
<a class="ansibleOptionLink" href="#parameter-device/services/profileType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Profile type of service (eg ISRv-mini).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/services/serviceName"></div>
<b>serviceName</b>
<a class="ansibleOptionLink" href="#parameter-device/services/serviceName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name of the service (eg Router-1).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/services/serviceType"></div>
<b>serviceType</b>
<a class="ansibleOptionLink" href="#parameter-device/services/serviceType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Service type (eg ISRV).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/services/vNicMapping"></div>
<b>vNicMapping</b>
<a class="ansibleOptionLink" href="#parameter-device/services/vNicMapping" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Nfv Profile's vNicMapping.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-device/services/vNicMapping/assignIpAddressToNetwork"></div>
<b>assignIpAddressToNetwork</b>
<a class="ansibleOptionLink" href="#parameter-device/services/vNicMapping/assignIpAddressToNetwork" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Assign ip address to network (eg true or false).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-device/services/vNicMapping/networkType"></div>
<b>networkType</b>
<a class="ansibleOptionLink" href="#parameter-device/services/vNicMapping/networkType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Type of connection (eg wan, lan or internal).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-device/vlanForL2"></div>
<b>vlanForL2</b>
<a class="ansibleOptionLink" href="#parameter-device/vlanForL2" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Nfv Profile's vlanForL2.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/vlanForL2/vlanDescription"></div>
<b>vlanDescription</b>
<a class="ansibleOptionLink" href="#parameter-device/vlanForL2/vlanDescription" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Vlan description(eg Access 4018).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/vlanForL2/vlanId"></div>
<b>vlanId</b>
<a class="ansibleOptionLink" href="#parameter-device/vlanForL2/vlanId" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Vlan id (eg 4018).</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-device/vlanForL2/vlanType"></div>
<b>vlanType</b>
<a class="ansibleOptionLink" href="#parameter-device/vlanForL2/vlanType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Vlan type(eg Access or Trunk).</div>
</td>
</tr>
<tr>
<td colspan="4">
<div class="ansibleOptionAnchor" id="parameter-id"></div>
<b>id</b>
<a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Id path parameter. Id of the NFV profile to be updated.</div>
</td>
</tr>
<tr>
<td colspan="4">
<div class="ansibleOptionAnchor" id="parameter-name"></div>
<b>name</b>
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name query parameter. Name of the profile to be updated.</div>
</td>
</tr>
<tr>
<td colspan="4">
<div class="ansibleOptionAnchor" id="parameter-profileName"></div>
<b>profileName</b>
<a class="ansibleOptionLink" href="#parameter-profileName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name of the profile to create NFV profile.</div>
</td>
</tr>
</table>
<br/>
.. Notes
.. Seealso
See Also
--------
.. seealso::
`Nfv Profile reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
Complete reference of the Nfv Profile object model.
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- name: Create
cisco.dnac.nfv_profile:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
device:
- customNetworks:
- connectionType: string
networkName: string
servicesToConnect:
- serviceName: string
vlanId: 0
vlanMode: string
customTemplate:
- deviceType: string
template: string
templateType: string
deviceTag: string
deviceType: string
directInternetAccessForFirewall: true
serviceProviderProfile:
- connect: true
connectDefaultGatewayOnWan: true
linkType: string
serviceProvider: string
services:
- firewallMode: string
imageName: string
profileType: string
serviceName: string
serviceType: string
vNicMapping:
- assignIpAddressToNetwork: string
networkType: string
vlanForL2:
- vlanDescription: string
vlanId: 0
vlanType: string
profileName: string
- name: Update by id
cisco.dnac.nfv_profile:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
device:
- currentDeviceTag: string
customNetworks:
- connectionType: string
networkName: string
servicesToConnect:
- serviceName: string
vlanId: 0
vlanMode: string
customTemplate:
- deviceType: string
template: string
templateType: string
deviceTag: string
directInternetAccessForFirewall: true
services:
- firewallMode: string
imageName: string
profileType: string
serviceName: string
serviceType: string
vNicMapping:
- assignIpAddressToNetwork: string
networkType: string
vlanForL2:
- vlanDescription: string
vlanId: 0
vlanType: string
id: string
name: string
- name: Delete by id
cisco.dnac.nfv_profile:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: absent
id: string
name: string
.. Facts
.. Return values
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
<b>dnac_response</b>
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>always</td>
<td>
<div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{
"executionId": "string",
"executionStatusUrl": "string",
"message": "string"
}</div>
</td>
</tr>
</table>
<br/><br/>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors