Get Nfvirtual VNF Attributes Parcel - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Nfvirtual VNF Attributes Parcel","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/a724d7a2-d5be-3cd7-8f42-0d775cdd69b7","info":{"title":"Feature Profiles - Mobility and NFV","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Feature Profiles in Mobility and NFV Solutions\n- Supporting mobility features and Network Function Virtualization (NFV) configurations.\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get VNF Attributes Profile Parcels for Networks feature profile","operationId":"GetNfvirtualVNFAttributesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"parcelId":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","$$ref":"#/components/schemas/CommonCommonDefs_uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"image_name":{"description":"Name of the image","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfNameOptionsDef"},"src":{"description":"Source of the image to be downloaded from","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":256,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_srcDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfSrcOptionsDef"},"checksum":{"description":"checksum","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":256,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_checksumDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfChecksumOptionsDef"},"username":{"description":"Username for the remote server","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":256,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_usernameDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfUsernameOptionsDef"},"password":{"description":"password for the remote server","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":256,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_passwordDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfPasswordOptionsDef"},"version":{"description":"Version","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_versionDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfVersionOptionsDef"},"vnf_type":{"description":"VNF Type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"default":"ROUTER","type":"string","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_vnf_typeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfVnf_typeOptionsDef"},"low_latency":{"description":"Latency","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfLow_latencyOptionsDef"},"sriov_supported":{"description":"Sriov supported","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfSriov_supportedOptionsDef"},"nocloud":{"description":"nocloud","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfNocloudOptionsDef"},"thick_disk_provisioning":{"description":"Disk Provisioning","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfThick_disk_provisioningOptionsDef"},"bootstrap_cloud_init_drive_type":{"description":"Cloud init drive type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"default":"cdrom","type":"string","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_bootstrap_cloud_init_drive_typeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfBootstrap_cloud_init_drive_typeOptionsDef"},"root_image_disk_format":{"description":"Root file disk bus","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"default":"qcow2","type":"string","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_root_image_disk_formatDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfRoot_image_disk_formatOptionsDef"},"console_type_serial":{"description":"Console Type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","default":true,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_console_type_serialDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfConsole_type_serialOptionsDef"},"vendor":{"description":"Name of the vendor","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_vendorDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_oneOfVendorOptionsDef"}},"required":["image_name","src"],"additionalProperties":false}},"required":["data"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_SchemaPayload"}},"$$ref":"#/components/schemas/getSingleNfvirtualNetworksVnfAttributesPayload"},"examples":{"get response example":{"value":{"parcelId":"09fc54fe-ff36-4640-ae57-c9e71a103902","parcelType":"vnf-attributes","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1701866357838,"lastUpdatedOn":1701866357838,"payload":{"data":{"name":{"optionType":"global","value":"xxx"},"src":{"optionType":"global","value":"xxx"},"checksum":{"optionType":"global","value":"xxx"},"username":{"optionType":"global","value":"xxx"},"password":{"optionType":"global","value":"xxx"},"version":{"optionType":"default","value":"17.10.1"},"vnf_type":{"optionType":"default","value":"ROUTER"},"low_latency":{"optionType":"default","value":true},"sriov_supported":{"optionType":"default","value":true},"nocloud":{"optionType":"global","value":"xxx"},"thick_disk_provisioning":{"optionType":"global","value":"xxx"},"bootstrap_cloud_init_drive_type":{"optionType":"default","value":"cdrom"},"root_image_disk_format":{"optionType":"default","value":"qcow2"},"console_type_serial":{"optionType":"global","value":"xxx"},"vendor":{"optionType":"global","value":"xxx"}}}},"$$ref":"#/components/examples/getSingleNfvirtualNetworksVnfAttributesExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e Nfvirtual Networks \u003e Vnf attributes-read","method":"get","path":"/v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}"}}