.. 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 .. 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 `_ (version 3.2.2). 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. .. 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.3.1 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
device
list / elements=string
Nfv Profile's device.
customNetworks
list / elements=string
Nfv Profile's customNetworks.
connectionType
string
Type of network connection from custom network (eg lan).
networkName
string
Name of custom network (eg cust-1).
servicesToConnect
list / elements=string
Nfv Profile's servicesToConnect.
serviceName
string
Name of service to be connected to the custom network (eg router-1).
vlanId
integer
Vlan id for the custom network(eg 4000).
vlanMode
string
Network mode (eg Access or Trunk).
customTemplate
list / elements=string
Nfv Profile's customTemplate.
deviceType
string
Type of the device(eg Cisco 5400 Enterprise Network Compute System).
template
string
Name of the template(eg NFVIS template).
templateType
string
Name of the template type to which template is associated (eg Cloud DayN Templates).
deviceTag
string
Device Tag name(eg dev1).
deviceType
string
Name of the device used in creating nfv profile.
directInternetAccessForFirewall
boolean
    Choices:
  • no
  • yes
Direct internet access value should be boolean (eg false or true).
serviceProviderProfile
list / elements=string
Nfv Profile's serviceProviderProfile.
connect
boolean
    Choices:
  • no
  • yes
Connection of service provider and device value should be boolean (eg true).
connectDefaultGatewayOnWan
boolean
    Choices:
  • no
  • yes
Connect default gateway connect value as boolean (eg true).
linkType
string
Name of connection type(eg GigabitEthernet).
serviceProvider
string
Name of the service provider(eg Airtel).
services
list / elements=string
Nfv Profile's services.
firewallMode
string
Firewall mode details example (routed, transparent).
imageName
string
Service image name (eg isrv-universalk9.16.12.01a.tar.gz).
profileType
string
Profile type of service (eg ISRv-mini).
serviceName
string
Name of the service (eg Router-1).
serviceType
string
Service type (eg ISRV).
vNicMapping
list / elements=string
Nfv Profile's vNicMapping.
assignIpAddressToNetwork
string
Assign ip address to network (eg true or false).
networkType
string
Type of connection (eg wan, lan or internal).
vlanForL2
list / elements=string
Nfv Profile's vlanForL2.
vlanDescription
string
Vlan description(eg Access 4018).
vlanId
integer
Vlan id (eg 4018).
vlanType
string
Vlan type(eg Access or Trunk).
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
id
string
Id path parameter. Id of the NFV profile to be updated.
name
string
Name query parameter. Name of the profile to be updated.
profileName
string
Name of the profile to create NFV profile.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

.. Attributes .. Notes Notes ----- .. note:: - Does not support ``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 See Also -------- .. seealso:: `Nfv Profile reference `_ 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 `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "executionId": "string", "executionStatusUrl": "string", "message": "string" }


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