cisco.dnac.nfv_profile module – Resource module for Nfv Profile
Note
This module is part of the cisco.dnac collection (version 6.18.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 ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.dnac
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.nfv_profile
.
New in cisco.dnac 3.1.0
Synopsis
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.
API to update a NFV Network profile.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.9
Parameters
Parameter |
Comments |
---|---|
Nfv Profile’s device. |
|
Nfv Profile’s customNetworks. |
|
Type of network connection from custom network (eg lan). |
|
Name of custom network (eg cust-1). |
|
Nfv Profile’s servicesToConnect. |
|
Name of service to be connected to the custom network (eg router-1). |
|
Vlan id for the custom network(eg 4000). |
|
Network mode (eg Access or Trunk). |
|
Nfv Profile’s customTemplate. |
|
Type of the device(eg Cisco 5400 Enterprise Network Compute System). |
|
Name of the template(eg NFVIS template). |
|
Name of the template type to which template is associated (eg Cloud DayN Templates). |
|
Device Tag name(eg dev1). |
|
Name of the device used in creating nfv profile. |
|
Direct internet access value should be boolean (eg false or true). Choices:
|
|
Nfv Profile’s serviceProviderProfile. |
|
Connection of service provider and device value should be boolean (eg true). Choices:
|
|
Connect default gateway connect value as boolean (eg true). Choices:
|
|
Name of connection type(eg GigabitEthernet). |
|
Name of the service provider(eg Airtel). |
|
Nfv Profile’s services. |
|
Firewall mode details example (routed, transparent). |
|
Service image name (eg isrv-universalk9.16.12.01a.tar.gz). |
|
Profile type of service (eg ISRv-mini). |
|
Name of the service (eg Router-1). |
|
Service type (eg ISRV). |
|
Nfv Profile’s vNicMapping. |
|
Assign ip address to network (eg true or false). |
|
Type of connection (eg wan, lan or internal). |
|
Nfv Profile’s vlanForL2. |
|
Vlan description(eg Access 4018). |
|
Vlan id (eg 4018). |
|
Vlan type(eg Access or Trunk). |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Id path parameter. Id of the NFV profile to be updated. |
|
Name query parameter. Name of the profile to be updated. |
|
Name of the profile to create NFV profile. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
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}, put /dna/intent/api/v1/nfv/network-profile/{id},
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
See Also
See also
- Cisco DNA Center documentation for Site Design CreateNFVProfile
Complete reference of the CreateNFVProfile API.
- Cisco DNA Center documentation for Site Design DeleteNFVProfile
Complete reference of the DeleteNFVProfile API.
- Cisco DNA Center documentation for Site Design UpdateNFVProfile
Complete reference of the UpdateNFVProfile API.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |