.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-entry .. role:: ansible-option-default .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.nfv_profile_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.nfv_profile module -- Resource module for Nfv Profile ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.4.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. 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:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Nfv Profile. - API to create network profile for different NFV topologies. - API to delete 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 >= 2.4.9 - python >= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device: .. rst-class:: ansible-option-title **device** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Profile's device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customNetworks: .. rst-class:: ansible-option-title **customNetworks** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Profile's customNetworks. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customNetworks/connectionType: .. rst-class:: ansible-option-title **connectionType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of network connection from custom network (eg lan). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customNetworks/networkName: .. rst-class:: ansible-option-title **networkName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of custom network (eg cust-1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customNetworks/servicesToConnect: .. rst-class:: ansible-option-title **servicesToConnect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Profile's servicesToConnect. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customNetworks/servicesToConnect/serviceName: .. rst-class:: ansible-option-title **serviceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of service to be connected to the custom network (eg router-1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customNetworks/vlanId: .. rst-class:: ansible-option-title **vlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Vlan id for the custom network(eg 4000). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customNetworks/vlanMode: .. rst-class:: ansible-option-title **vlanMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network mode (eg Access or Trunk). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customTemplate: .. rst-class:: ansible-option-title **customTemplate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Profile's customTemplate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customTemplate/deviceType: .. rst-class:: ansible-option-title **deviceType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of the device. Allowed values are 'Cisco 5400 Enterprise Network Compute System', 'Cisco Integrated Services Virtual Router', 'Cisco Adaptive Security Virtual Appliance (ASAv)', 'NFVIS', 'ASAV'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customTemplate/template: .. rst-class:: ansible-option-title **template** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the template(eg NFVIS template). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/customTemplate/templateType: .. rst-class:: ansible-option-title **templateType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the template type to which template is associated (eg Cloud DayN Templates). Allowed values are 'Onboarding Template(s)' and 'Day-N-Template(s)'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/deviceTag: .. rst-class:: ansible-option-title **deviceTag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Tag name(eg dev1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/deviceType: .. rst-class:: ansible-option-title **deviceType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the device used in creating nfv profile. Allowed values are 'Cisco 5400 Enterprise Network Compute System', 'Cisco 5100 Enterprise Network Compute System'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/directInternetAccessForFirewall: .. rst-class:: ansible-option-title **directInternetAccessForFirewall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Direct internet access value should be boolean (eg false or true). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/serviceProviderProfile: .. rst-class:: ansible-option-title **serviceProviderProfile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Profile's serviceProviderProfile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/serviceProviderProfile/connect: .. rst-class:: ansible-option-title **connect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Connection of service provider and device value should be boolean (eg true). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/serviceProviderProfile/connectDefaultGatewayOnWan: .. rst-class:: ansible-option-title **connectDefaultGatewayOnWan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Connect default gateway connect value as boolean (eg true). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/serviceProviderProfile/linkType: .. rst-class:: ansible-option-title **linkType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of connection type(eg GigabitEthernet). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/serviceProviderProfile/serviceProvider: .. rst-class:: ansible-option-title **serviceProvider** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the service provider(eg Airtel). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/services: .. rst-class:: ansible-option-title **services** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Profile's services. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/services/firewallMode: .. rst-class:: ansible-option-title **firewallMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Firewall mode details example (routed, transparent). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/services/imageName: .. rst-class:: ansible-option-title **imageName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Service image name (eg isrv-universalk9.16.12.01a.tar.gz). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/services/profileType: .. rst-class:: ansible-option-title **profileType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Profile type of service (eg ISRv-mini). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/services/serviceName: .. rst-class:: ansible-option-title **serviceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the service (eg Router-1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/services/serviceType: .. rst-class:: ansible-option-title **serviceType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Service type (eg ISRV). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/services/vNicMapping: .. rst-class:: ansible-option-title **vNicMapping** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Profile's vNicMapping. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/services/vNicMapping/assignIpAddressToNetwork: .. rst-class:: ansible-option-title **assignIpAddressToNetwork** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Assign ip address to network (eg true or false). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/services/vNicMapping/networkType: .. rst-class:: ansible-option-title **networkType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of connection (eg wan, lan or internal). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/vlanForL2: .. rst-class:: ansible-option-title **vlanForL2** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Nfv Profile's vlanForL2. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/vlanForL2/vlanDescription: .. rst-class:: ansible-option-title **vlanDescription** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Vlan description(eg Access 4018). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/vlanForL2/vlanId: .. rst-class:: ansible-option-title **vlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Vlan id (eg 4018). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-device/vlanForL2/vlanType: .. rst-class:: ansible-option-title **vlanType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Vlan type(eg Access or Trunk). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. Id of the NFV profile to be updated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name query parameter. Name of the profile to be updated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-profileName: .. rst-class:: ansible-option-title **profileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the profile to create NFV profile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are site_design.SiteDesign.create_nfv_profile, site_design.SiteDesign.delete_nfv_profile, site_design.SiteDesign.update_nfv_profile, - Paths used are post /dna/intent/api/v1/nfv/network-profile, delete /dna/intent/api/v1/nfv/network-profile/{id}, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK - The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso .. 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 `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.nfv_profile_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` "{\\n \\"executionId\\": \\"string\\",\\n \\"executionStatusUrl\\": \\"string\\",\\n \\"message\\": \\"string\\"\\n}\\n" .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors