openapi: 3.2.0 info: title: Feature Profiles - Mobility and NFV Configuration - Feature Profile (NFVirtual) API description: "Feature profiles associated with UX 2.0 configuration\nIncludes API operations for the following:\n Feature Profiles in Mobility and NFV Solutions\n Supporting mobility features and Network Function Virtualization (NFV) configurations." contact: email: vmanage@cisco.com license: name: Commercial License url: https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html version: 26.1.0+2026-01-06 x-provenance: method: harvested authored_by: Cisco Catalyst SD-WAN harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true provider_published: true source_host: pubhub.devnetcloud.com note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host. x-evidence: - type: source url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/ - type: source url: https://developer.cisco.com/docs/sdwan/ servers: - url: /dataservice tags: - name: Configuration - Feature Profile (NFVirtual) paths: /v1/feature-profile/nfvirtual/cli: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create a Nfvirtual CLI Feature Profile operationId: CreateNfvirtualCLIFeatureProfile requestBody: description: Nfvirtual Feature profile for CLI content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string fromFeatureProfile: type: object description: from another feature profile oneOf: - properties: copy: 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' required: - copy additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPostRequest_fromFeatureProfileDef' required: - name - description additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPostRequest_SchemaPayload' examples: FeatureProfile-ConfigGroup1-NY: value: name: FeatureProfile-ConfigGroup1-NY description: Feature Profile for config group 1 for NY site $$ref: '#/components/examples/FeatureprofileCommonPostRequest_FeatureProfile-ConfigGroup1-NY' FeatureProfile-ConfigGroup1-COPY: value: name: FeatureProfile-ConfigGroup1-COPY description: Copy Feature Profile from EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99 fromFeatureProfile: copy: EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99 $$ref: '#/components/examples/FeatureprofileCommonPostRequest_FeatureProfile-ConfigGroup1-COPY' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPostResponse_SchemaPayload' examples: example_1: value: id: Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB $$ref: '#/components/examples/FeatureprofileCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual CLI Add On-write get: tags: - Configuration - Feature Profile (NFVirtual) description: Get all Nfvirtual CLI Feature Profiles operationId: GetAllNfvirtualCLIFeatureProfiles parameters: - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: limit in: query description: Pagination limit schema: type: integer format: int32 default: 0 responses: '200': description: Success content: application/json: schema: type: array items: type: object properties: profileId: 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' profileName: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' profileType: type: string enum: - cli 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 description: type: string solution: type: string enum: - nfvirtual $$ref: '#/components/schemas/getListNfvirtualCliPayload' examples: get response example: value: - profileId: bc99ae4f-0ac3-4a51-95cb-c718953143ce profileName: cg1_LAN solution: nfvirtual profileType: cli createdBy: admin lastUpdatedBy: admin createdOn: 1701850310222 description: cg1 cli Profile lastUpdatedOn: 1702292120081 $$ref: '#/components/examples/getListNfvirtualCliExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual CLI Add On-read /v1/feature-profile/nfvirtual/cli/{cliId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get nfvirtual CLI Feature Profile with cliId operationId: GetNfvirtualCLIFeatureProfileByid parameters: - name: cliId in: path description: Feature Profile Id required: true schema: 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}' type: string responses: '200': description: Success content: application/json: schema: type: object properties: profileId: 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' profileType: type: string enum: - cli profileName: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string solution: type: string enum: - nfvirtual 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 associatedProfileParcels: type: array items: type: object minItems: 0 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 payload: type: object subparcels: type: array minItems: 0 items: type: object $$ref: '#/components/schemas/getSingleNfvirtualCliPayload' examples: get response example: value: profileName: cg1_LAN lastUpdatedBy: admin description: cg1 cli Profile profileParcelCount: 613 createdOn: 1701850310222 '@rid': 3262 profileType: cli solution: nfvirtual createdBy: admin profileId: bc99ae4f-0ac3-4a51-95cb-c718953143ce lastUpdatedOn: 1702292120081 associatedProfileParcels: [] $$ref: '#/components/examples/getSingleNfvirtualCliExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual CLI Add On-read delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete nfvirtual CLI Feature Profile operationId: DeleteNfvirtualCLIFeatureProfile parameters: - name: cliId in: path required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual CLI Add On-write put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a Nfvirtual CLI Feature Profile operationId: EditNfvirtualCLIFeatureProfile parameters: - name: cliId in: path description: Feature Profile Id required: true schema: 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}' type: string requestBody: description: Nfvirtual Feature profile fo CLI content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string required: - name - description additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPutRequest_SchemaPayload' examples: FeatureProfile-ConfigGroup1-NY: value: name: FeatureProfile-ConfigGroup1-NY description: Feature Profile for config group 1 for NY site $$ref: '#/components/examples/FeatureprofileCommonPutRequest_FeatureProfile-ConfigGroup1-NY' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPutResponse_SchemaPayload' examples: example_1: value: id: Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB $$ref: '#/components/examples/FeatureprofileCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual CLI Add On-write /v1/feature-profile/nfvirtual/cli/{cliId}/config: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create CLI Profile Parcel for CLI feature profile operationId: CreateNfvirtualCLIParcel parameters: - name: cliId in: path description: CLI Feature Profile ID required: true schema: 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}' type: string requestBody: description: CLI Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: config: type: string required: - config additionalProperties: false required: - name - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualCliConfigPostRequest_SchemaPayload' examples: CliConfigParcel1: value: data: config: vrf definition 100 name: CliConfigParcel1 $$ref: '#/components/examples/ProfileparcelNfvirtualCliConfigPostRequest_CliConfigParcel1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual CLI Add On > Cli-write /v1/feature-profile/nfvirtual/cli/{cliId}/config/{configId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get CLI Profile Parcels for CLI feature profile operationId: getNfvirtualCLIParcel parameters: - name: cliId in: path description: CLI Feature Profile ID required: true schema: 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}' type: string - name: configId in: path description: CLI Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: config: type: string required: - config additionalProperties: false required: - name - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualCliConfigPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualCliConfigPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: config createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: config: vrf definition 100 $$ref: '#/components/examples/getSingleNfvirtualCliConfigExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual CLI Add On > Cli-read put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit CLI Profile Parcel for CLI feature profile operationId: EditNfvirtualCLIParcel parameters: - name: cliId in: path description: CLI Feature Profile ID required: true schema: 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}' type: string - name: configId in: path description: CLI Parcel ID required: true schema: 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}' type: string requestBody: description: CLI Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: config: type: string required: - config additionalProperties: false required: - name - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualCliConfigPutRequest_SchemaPayload' examples: CliConfigParcel1: value: data: config: vrf definition 100 name: CliConfigParcel1 $$ref: '#/components/examples/ProfileparcelNfvirtualCliConfigPutRequest_CliConfigParcel1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual CLI Add On > Cli-write delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete CLI Profile Parcel for CLI feature profile operationId: DeleteNfvirtualCLIParcel parameters: - name: cliId in: path description: CLI Feature Profile ID required: true schema: 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}' type: string - name: configId in: path description: CLI Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual CLI Add On > Cli-write /v1/feature-profile/nfvirtual/networks: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get all Nfvirtual Feature Profiles operationId: GetAllNfvirtualNetworksFeatureProfiles parameters: - name: offset in: query description: Pagination offset required: true schema: type: integer format: int32 default: 0 - name: limit in: query description: Pagination limit required: true schema: type: integer format: int32 default: 0 responses: '200': description: Success content: application/json: schema: type: array items: type: object properties: profileId: 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' profileName: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' profileType: type: string enum: - networks 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 description: type: string solution: type: string enum: - nfvirtual $$ref: '#/components/schemas/getListNfvirtualNetworksPayload' examples: get response example: value: - profileId: bc99ae4f-0ac3-4a51-95cb-c718953143ce profileName: cg1_LAN solution: nfvirtual profileType: networks createdBy: admin lastUpdatedBy: admin createdOn: 1701850310222 description: cg1 networks Profile lastUpdatedOn: 1702292120081 $$ref: '#/components/examples/getListNfvirtualNetworksExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-read post: tags: - Configuration - Feature Profile (NFVirtual) description: Create a nfvirtual Networks Feature Profile operationId: CreateNfvirtualNetworksFeatureProfile requestBody: description: Nfvirtual Feature profile content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string fromFeatureProfile: type: object description: from another feature profile oneOf: - properties: copy: 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' required: - copy additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPostRequest_fromFeatureProfileDef' required: - name - description additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPostRequest_SchemaPayload' examples: FeatureProfile-ConfigGroup1-NY: value: name: FeatureProfile-ConfigGroup1-NY description: Feature Profile for config group 1 for NY site $$ref: '#/components/examples/FeatureprofileCommonPostRequest_FeatureProfile-ConfigGroup1-NY' FeatureProfile-ConfigGroup1-COPY: value: name: FeatureProfile-ConfigGroup1-COPY description: Copy Feature Profile from EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99 fromFeatureProfile: copy: EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99 $$ref: '#/components/examples/FeatureprofileCommonPostRequest_FeatureProfile-ConfigGroup1-COPY' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPostResponse_SchemaPayload' examples: example_1: value: id: Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB $$ref: '#/components/examples/FeatureprofileCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-write /v1/feature-profile/nfvirtual/networks/ovsnetwork/{networkId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get all Nfvirtual OVS Networks Feature Profile with networkId operationId: GetAllNfvirtualOvsNetworksFeatureProfileByProfileId parameters: - name: networkId in: path description: Feature Profile Id required: true schema: 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}' type: string - name: details in: query description: get feature details required: true schema: type: boolean default: false 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: network_name: description: Name of the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfNameOptionsDef' interface_name: description: Set interface_name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_interface_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfInterface_nameOptionsDef' bridge: description: name of the bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfBridgeOptionsDef' mode: description: 'Set type of switch port: access/trunk' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - access - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfModeOptionsDef' vlan: description: Set vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfVlanOptionsDef' native_vlan: description: Set native vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_native_lanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfNative_lanOptionsDef' ip_address: description: Set Subnet-address type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfAddressOptionsDef' netmask: description: Set Subnet-mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfNetmaskOptionsDef' dhcp: description: dhcp 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfDhcpOptionsDef' gateway: description: gateway type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_gatewayDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfGatewayOptionsDef' required: - network_name additionalProperties: false required: - data x-metadata: minVManageVersion: 20.16.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualNetworksOvsnetworkPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: ovsnetwork createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: name: optionType: global value: xxx interface_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: xxx vlan: optionType: global value: xxx native_lan: optionType: global value: xxx ip_address: optionType: global value: xxx netmask: optionType: global value: xxx dhcp: optionType: global value: xxx gateway: optionType: global value: xxx $$ref: '#/components/examples/getSingleNfvirtualNetworksOvsnetworkExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-read /v1/feature-profile/nfvirtual/networks/{networkId}: put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a Nfvirtual Networks Feature Profile operationId: EditNfvirtualNetworksFeatureProfile parameters: - name: networkId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: Nfvirtual Feature profile content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string required: - name - description additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPutRequest_SchemaPayload' examples: FeatureProfile-ConfigGroup1-NY: value: name: FeatureProfile-ConfigGroup1-NY description: Feature Profile for config group 1 for NY site $$ref: '#/components/examples/FeatureprofileCommonPutRequest_FeatureProfile-ConfigGroup1-NY' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPutResponse_SchemaPayload' examples: example_1: value: id: Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB $$ref: '#/components/examples/FeatureprofileCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-write delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a Nfvirtual Networks Feature Profile operationId: DeleteNfvirtualNetworksFeatureProfile parameters: - name: networkId in: path required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-write get: tags: - Configuration - Feature Profile (NFVirtual) description: Get a Nfvirtual Networks Feature Profile with networkId operationId: GetNfvirtualNetworksFeatureProfileByProfileId parameters: - name: networkId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: details in: query description: get feature details required: true schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object properties: profileId: 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' profileType: type: string enum: - networks profileName: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string solution: type: string enum: - nfvirtual 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 associatedProfileParcels: type: array items: type: object minItems: 0 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 payload: type: object subparcels: type: array minItems: 0 items: type: object $$ref: '#/components/schemas/getSingleNfvirtualNetworksPayload' examples: get response example: value: profileName: cg1_LAN lastUpdatedBy: admin description: cg1 networks Profile profileParcelCount: 613 createdOn: 1701850310222 '@rid': 3262 profileType: networks solution: nfvirtual createdBy: admin profileId: bc99ae4f-0ac3-4a51-95cb-c718953143ce lastUpdatedOn: 1702292120081 associatedProfileParcels: [] $$ref: '#/components/examples/getSingleNfvirtualNetworksExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-read /v1/feature-profile/nfvirtual/networks/{networksId}/lan: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create LAN Profile Parcel for Networks feature profile operationId: CreateNfvirtualLANParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: LAN config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: interface_name: description: ' Lan Interface Name' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_portDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_oneOfPortOptionsDef' ip_address: description: ' ip address for static' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_ipAddressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_oneOfIpAddressOptionsDef' netmask: description: subnet mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_oneOfNetmaskOptionsDef' network_name: description: Name of the WAN Network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_network_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_oneOfNetwork_nameOptionsDef' bridge: description: Name of the WAN Bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_oneOfBridgeOptionsDef' mode: description: Trunk or Access Mode of the Interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: trunk enum: - trunk - access type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: enum: - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_defaultModeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_oneOfModeOptionsDef' vlan: description: Range of VLANs for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_oneOfVlanOptionsDef' native_vlan: description: Native Vlan for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_native_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_oneOfNative_vlanOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPostRequest_SchemaPayload' examples: LANParcelGlobalDefault: value: data: interface_name: optionType: global value: xxx ip_address: optionType: global value: xxx netmask: optionType: global value: xxx network_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: trunk name: LANParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksLanPostRequest_LANParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Lan-write /v1/feature-profile/nfvirtual/networks/{networksId}/lan/{lanId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get LAN Profile Parcels for Networks feature profile operationId: GetNfvirtualLANParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: lanId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: interface_name: description: Lan Interface Name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_portDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfPortOptionsDef' ip_address: description: ' ip address for static' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_ipAddressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfIpAddressOptionsDef' netmask: description: subnet mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfNetmaskOptionsDef' network_name: description: Name of the WAN Network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_network_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfNetwork_nameOptionsDef' bridge: description: Name of the WAN Bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfBridgeOptionsDef' mode: description: Trunk or Access Mode of the Interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: trunk enum: - trunk - access type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: enum: - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_defaultModeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfModeOptionsDef' vlan: description: Range of VLANs for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfVlanOptionsDef' native_vlan: description: Native Vlan for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_native_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfNative_vlanOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualNetworksLanPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: lan createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: interface_name: optionType: global value: xxx ip_address: optionType: global value: xxx netmask: optionType: global value: xxx network_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: trunk vlan: optionType: global value: xxx native_vlan: optionType: global value: xxx $$ref: '#/components/examples/getSingleNfvirtualNetworksLanExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Lan-read put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a LAN Profile Parcel for networks feature profile operationId: EditNfvirtualLANParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: lanId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: LAN Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: interface_name: description: Lan Interface Name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_portDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfPortOptionsDef' ip_address: description: ' ip address for static' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_ipAddressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfIpAddressOptionsDef' netmask: description: subnet mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfNetmaskOptionsDef' network_name: description: Name of the WAN Network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_network_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfNetwork_nameOptionsDef' bridge: description: Name of the WAN Bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfBridgeOptionsDef' mode: description: Trunk or Access Mode of the Interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: trunk enum: - trunk - access type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: enum: - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_defaultModeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfModeOptionsDef' vlan: description: Range of VLANs for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfVlanOptionsDef' native_vlan: description: Native Vlan for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_native_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_oneOfNative_vlanOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksLanPutRequest_SchemaPayload' examples: LANParcelGlobalDefault: value: data: interface_name: optionType: global value: xxx ip_address: optionType: global value: xxx netmask: optionType: global value: xxx network_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: trunk vlan: optionType: global value: xxx native_vlan: optionType: global value: xxx name: LANParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksLanPutRequest_LANParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Lan-write delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a LAN Profile Parcel for Networks feature profile operationId: DeleteNfvirtualLANParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: lanId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Lan-write /v1/feature-profile/nfvirtual/networks/{networksId}/ovsnetwork: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create OVS Network Profile Parcel for Networks feature profile operationId: CreateNfvirtualOVSNetworkParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: OVS Network Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: network_name: description: Name of the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfNameOptionsDef' interface_name: description: Set interface_name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_interface_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfInterface_nameOptionsDef' bridge: description: name of the bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfBridgeOptionsDef' mode: description: 'Set type of switch port: access/trunk' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - access - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfModeOptionsDef' vlan: description: Set vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfVlanOptionsDef' native_vlan: description: Set native vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_native_lanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfNative_lanOptionsDef' ip_address: description: Set Subnet-address type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfAddressOptionsDef' netmask: description: Set Subnet-mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfNetmaskOptionsDef' dhcp: description: dhcp 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfDhcpOptionsDef' gateway: description: gateway type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_gatewayDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_oneOfGatewayOptionsDef' required: - network_name additionalProperties: false required: - data x-metadata: minVManageVersion: 20.16.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_SchemaPayload' examples: NetworkParcelGlobalDefault: value: data: name: optionType: global value: xxx interface_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: xxx vlan: optionType: global value: xxx native_lan: optionType: global value: xxx ip_address: optionType: global value: xxx netmask: optionType: global value: xxx dhcp: optionType: global value: xxx gateway: optionType: global value: xxx name: NetworkParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksOvsnetworkPostRequest_NetworkParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Ovsnetwork-write /v1/feature-profile/nfvirtual/networks/{networksId}/ovsnetwork/{ovsNetworkId}: put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a OVS Network Profile Parcel for Networks feature profile operationId: EditNfvirtualOVSNetworkParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: ovsNetworkId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: OVS Network Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: network_name: description: Name of the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfNameOptionsDef' interface_name: description: Set interface_name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_interface_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfInterface_nameOptionsDef' bridge: description: name of the bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfBridgeOptionsDef' mode: description: 'Set type of switch port: access/trunk' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - access - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfModeOptionsDef' vlan: description: Set vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfVlanOptionsDef' native_vlan: description: Set native vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_native_lanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfNative_lanOptionsDef' ip_address: description: Set Subnet-address type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfAddressOptionsDef' netmask: description: Set Subnet-mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfNetmaskOptionsDef' dhcp: description: dhcp 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfDhcpOptionsDef' gateway: description: gateway type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_gatewayDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfGatewayOptionsDef' required: - network_name additionalProperties: false required: - data x-metadata: minVManageVersion: 20.16.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_SchemaPayload' examples: NetworkParcelGlobalDefault: value: data: name: optionType: global value: xxx interface_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: xxx vlan: optionType: global value: xxx native_lan: optionType: global value: xxx ip_address: optionType: global value: xxx netmask: optionType: global value: xxx dhcp: optionType: global value: xxx gateway: optionType: global value: xxx name: NetworkParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_NetworkParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Ovsnetwork-write get: tags: - Configuration - Feature Profile (NFVirtual) description: Get OVS Network Profile Parcels for Networks feature profile operationId: GetNfvirtualOVSNetworkParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: ovsNetworkId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: network_name: description: Name of the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfNameOptionsDef' interface_name: description: Set interface_name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_interface_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfInterface_nameOptionsDef' bridge: description: name of the bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfBridgeOptionsDef' mode: description: 'Set type of switch port: access/trunk' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - access - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfModeOptionsDef' vlan: description: Set vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfVlanOptionsDef' native_vlan: description: Set native vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_native_lanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfNative_lanOptionsDef' ip_address: description: Set Subnet-address type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfAddressOptionsDef' netmask: description: Set Subnet-mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfNetmaskOptionsDef' dhcp: description: dhcp 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfDhcpOptionsDef' gateway: description: gateway type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_gatewayDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_oneOfGatewayOptionsDef' required: - network_name additionalProperties: false required: - data x-metadata: minVManageVersion: 20.16.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksOvsnetworkPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualNetworksOvsnetworkPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: ovsnetwork createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: name: optionType: global value: xxx interface_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: xxx vlan: optionType: global value: xxx native_lan: optionType: global value: xxx ip_address: optionType: global value: xxx netmask: optionType: global value: xxx dhcp: optionType: global value: xxx gateway: optionType: global value: xxx $$ref: '#/components/examples/getSingleNfvirtualNetworksOvsnetworkExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Ovsnetwork-read delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a OVS Network Profile Parcel for Networks feature profile operationId: DeleteNfvirtualOVSNetworkParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: ovsNetworkId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Ovsnetwork-write /v1/feature-profile/nfvirtual/networks/{networksId}/routes: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create Routes Profile config for Networks feature profile operationId: CreateNfvirtualRoutesParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: Routes config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: routes: description: List of Routes type: array uniqueItems: true minItems: 0 maxItems: 25 items: type: object properties: network_address: description: Ip address for network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\/)([1-9]|[1-2][0-9]|3[012])$ $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPostRequest_routesNetwork_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPostRequest_oneOfRoutesNetwork_addressOptionsDef' nexthop_address: description: Ip address for next hop type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPostRequest_routesNexthop_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPostRequest_oneOfRoutesNexthop_addressOptionsDef' required: [] additionalProperties: false required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPostRequest_SchemaPayload' examples: RoutesParcelGlobalDefault: value: data: routes: - network_address: optionType: global value: xxx nexthop_address: optionType: global value: xxx - network_address: optionType: global value: xxx nexthop_address: optionType: global value: xxx name: RoutesParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksRoutesPostRequest_RoutesParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Routes-write /v1/feature-profile/nfvirtual/networks/{networksId}/routes/{routesId}: delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete Routes Profile config for Networks feature profile operationId: DeleteNfvirtualRoutesParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: routesId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Routes-write put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a Routes Profile Parcel for networks feature profile operationId: EditNfvirtualRoutesParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: routesId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: Routes Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: routes: description: List of Routes type: array uniqueItems: true minItems: 0 maxItems: 25 items: type: object properties: network_address: description: Ip address for network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\/)([1-9]|[1-2][0-9]|3[012])$ $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_routesNetwork_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_oneOfRoutesNetwork_addressOptionsDef' nexthop_address: description: Ip address for next hop type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: routesNexthop_addressDef: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_routesNexthop_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_oneOfRoutesNexthop_addressOptionsDef' required: [] additionalProperties: false required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_SchemaPayload' examples: RoutesParcelGlobalDefault: value: data: routes: - network_address: optionType: global value: xxx nexthop_address: optionType: global value: xxx - network_address: optionType: global value: xxx nexthop_address: optionType: global value: xxx name: RoutesParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksRoutesPutRequest_RoutesParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Routes-write get: tags: - Configuration - Feature Profile (NFVirtual) description: Get Routes Profile Parcels for Networks feature profile operationId: GetNfvirtualRoutesParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: routesId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: routes: description: List of Routes type: array uniqueItems: true minItems: 0 maxItems: 25 items: type: object properties: network_address: description: Ip address for network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\/)([1-9]|[1-2][0-9]|3[012])$ $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_routesNetwork_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_oneOfRoutesNetwork_addressOptionsDef' nexthop_address: description: Ip address for next hop type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: routesNexthop_addressDef: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_routesNexthop_addressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_oneOfRoutesNexthop_addressOptionsDef' required: [] additionalProperties: false required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksRoutesPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualNetworksRoutesPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: routes createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: routes: - network_address: optionType: global value: xxx nexthop_address: optionType: global value: xxx - network_address: optionType: global value: xxx nexthop_address: optionType: global value: xxx $$ref: '#/components/examples/getSingleNfvirtualNetworksRoutesExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Routes-read /v1/feature-profile/nfvirtual/networks/{networksId}/switch: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create Switch Profile config for Networks feature profile operationId: CreateNfvirtualSwitchParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: Switch config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: interfaces: description: List of Interfaces type: array uniqueItems: true minItems: 0 maxItems: 8 items: type: object properties: interface_name: description: Interface Name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - gigabitEthernet1/0 - gigabitEthernet1/1 - gigabitEthernet1/2 - gigabitEthernet1/3 - gigabitEthernet1/4 - gigabitEthernet1/5 - gigabitEthernet1/6 - gigabitEthernet1/7 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPostRequest_interfacesInterface_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPostRequest_oneOfInterfacesInterface_nameOptionsDef' vlan: description: Range of VLANs for the interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string default: '1' pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?)(,(([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?))*) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPostRequest_interfacesVlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPostRequest_oneOfInterfacesVlanOptionsDef' mode: description: Trunk or Access Mode of the Interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: access enum: - trunk - access type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPostRequest_interfacesModeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPostRequest_oneOfInterfacesModeOptionsDef' native_vlan: description: Native Vlan for the interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPostRequest_interfacesNative_vlanDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPostRequest_oneOfInterfacesNative_vlanOptionsDef' required: - interface_name additionalProperties: false required: [] additionalProperties: false required: - data x-metadata: supportedDeviceTypes: - vedge-nfvis-ENCS5400 minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPostRequest_SchemaPayload' examples: SwitchParcelGlobalDefault: value: data: interfaces: - interface_name: optionType: global value: xxx vlan: optionType: global value: xxx mode: optionType: global value: access native_vlan: optionType: global value: xxx name: SwitchParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksSwitchPostRequest_SwitchParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Switch-write /v1/feature-profile/nfvirtual/networks/{networksId}/switch/{switchId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get Switch Profile Parcels for Networks feature profile operationId: GetNfvirtualSwitchParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: switchId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: interfaces: description: List of Interfaces type: array uniqueItems: true minItems: 0 maxItems: 8 items: type: object properties: interface_name: description: Interface Name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - gigabitEthernet1/0 - gigabitEthernet1/1 - gigabitEthernet1/2 - gigabitEthernet1/3 - gigabitEthernet1/4 - gigabitEthernet1/5 - gigabitEthernet1/6 - gigabitEthernet1/7 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_interfacesInterface_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_oneOfInterfacesInterface_nameOptionsDef' vlan: description: Range of VLANs for the interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string default: '1' pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?)(,(([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?))*) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_interfacesVlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_oneOfInterfacesVlanOptionsDef' mode: description: Trunk or Access Mode of the Interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: access enum: - trunk - access type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_interfacesModeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_oneOfInterfacesModeOptionsDef' native_vlan: description: Native Vlan for the interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_interfacesNative_vlanDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_oneOfInterfacesNative_vlanOptionsDef' required: - interface_name additionalProperties: false required: [] additionalProperties: false required: - data x-metadata: supportedDeviceTypes: - vedge-nfvis-ENCS5400 minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualNetworksSwitchPayload' examples: get response example: description: get response example value: payload: name: switch description: '' data: interfaces: - interface_name: optionType: global value: gigabitEthernet1/0 vlan: optionType: global value: 255-257 mode: optionType: global value: trunk native_vlan: optionType: global value: 1 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Switch-read put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a Switch Profile Parcel for networks feature profile operationId: EditNfvirtualSwitchParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: switchId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: Switch Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: interfaces: description: List of Interfaces type: array uniqueItems: true minItems: 0 maxItems: 8 items: type: object properties: interface_name: description: Interface Name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - gigabitEthernet1/0 - gigabitEthernet1/1 - gigabitEthernet1/2 - gigabitEthernet1/3 - gigabitEthernet1/4 - gigabitEthernet1/5 - gigabitEthernet1/6 - gigabitEthernet1/7 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_interfacesInterface_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_oneOfInterfacesInterface_nameOptionsDef' vlan: description: Range of VLANs for the interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string default: '1' pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?)(,(([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?))*) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_interfacesVlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_oneOfInterfacesVlanOptionsDef' mode: description: Trunk or Access Mode of the Interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: access enum: - trunk - access type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_interfacesModeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_oneOfInterfacesModeOptionsDef' native_vlan: description: Native Vlan for the interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_interfacesNative_vlanDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_oneOfInterfacesNative_vlanOptionsDef' required: - interface_name additionalProperties: false required: [] additionalProperties: false required: - data x-metadata: supportedDeviceTypes: - vedge-nfvis-ENCS5400 minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksSwitchPutRequest_SchemaPayload' examples: SwitchParcelGlobalDefault: value: data: interfaces: - interface_name: optionType: global value: xxx vlan: optionType: global value: xxx mode: optionType: global value: access native_vlan: optionType: global value: xxx name: SwitchParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksSwitchPutRequest_SwitchParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Switch-write delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete Switch Profile config for Networks feature profile operationId: DeleteNfvirtualSwitchParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: switchId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Switch-write /v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create VNF Attributes Profile config for Networks feature profile operationId: CreateNfvirtualVNFAttributesParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: VNF Attributes config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ 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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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 x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.src.value valuesRegex: - ^(http|ftp)://.* description: Register VM images from secure protocols. reason: Registering VM images using Legacy protocols is not recommended. remediation: Register VM images from secure protocols. $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_srcDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_checksumDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_usernameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_passwordDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_oneOfPasswordOptionsDef' version: description: Version type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_versionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_vnf_typeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_bootstrap_cloud_init_drive_typeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_root_image_disk_formatDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_console_type_serialDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_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/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_vendorDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_oneOfVendorOptionsDef' required: - image_name - src additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_SchemaPayload' examples: example_1: value: 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 name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksVnfAttributesPostRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Vnf attributes-write /v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}: put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a VNF Attributes Profile Parcel for networks feature profile operationId: EditNfvirtualVNFAttributesParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: vnfAttributesId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: VNF Attributes Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ 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 x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.src.value valuesRegex: - ^(http|ftp)://.* description: Register VM images from secure protocols. reason: Registering VM images using Legacy protocols is not recommended. remediation: Register VM images from secure protocols. $$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' examples: example_1: value: 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 name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksVnfAttributesPutRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Vnf attributes-write delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete VNF Attributes Profile config for Networks feature profile operationId: DeleteNfvirtualVNFAttributesParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: vnfAttributesId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Vnf attributes-write get: 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: 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}' type: string - name: vnfAttributesId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ 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 x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.src.value valuesRegex: - ^(http|ftp)://.* description: Register VM images from secure protocols. reason: Registering VM images using Legacy protocols is not recommended. remediation: Register VM images from secure protocols. $$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 > Nfvirtual Networks > Vnf attributes-read /v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}/vnf: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create VNF Profile Parcel for Networks feature profile operationId: CreateNfvirtualVNFParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: vnfAttributesId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: VNF config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: name: description: Name of the VM to be deployed type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_nameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfNameOptionsDef' image: description: Name of the Image to be used for VM deployment type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_imageDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfImageOptionsDef' bootup_time: description: Boot up time for the VM type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: -1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_bootup_timeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfBootup_timeOptionsDef' deployment_datastore: description: Deployment datastore type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - datastore1 - datastore2 - datastore3 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_deployment_datastoreDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfDeployment_datastoreOptionsDef' vcpus: description: Number of virtual cores for the Flavor type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 16 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_vcpusDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfVcpusOptionsDef' memory_mb: description: Memory in MB for the Flavor type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 256 maximum: 73728 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_memory_mbDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfMemory_mbOptionsDef' root_disk_mb: description: Root disk size in MB type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1024 maximum: 2048000 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_root_disk_mbDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfRoot_disk_mbOptionsDef' dayZero: description: DayZero file type: array uniqueItems: true items: type: object properties: mount_point: description: Destination for Day zero config file type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_dayZeroMount_pointDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfDayZeroMount_pointOptionsDef' dayZeroFileContent: description: Day zero config file type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_dayZeroDayZeroFileContentDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfDayZeroDayZeroFileContentOptionsDef' customProperty: description: custom property type: array uniqueItems: true items: type: object properties: name: description: Name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_dayZeroCustomPropertyNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfDayZeroCustomPropertyNameOptionsDef' val: description: Value type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_dayZeroCustomPropertyValDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: oneOf: - type: string pattern: ^\{\{([a-zA-Z0-9.\-_]+):([a-zA-Z0-9.\-_]+)\}\}$ minLength: 1 maxLength: 256 - type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 64 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfCustomVarNameValueDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfDayZeroCustomPropertyValOptionsDef' encrypted_val: description: Encrypted value type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_dayZeroCustomPropertyEncrypted_valDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: oneOf: - type: string pattern: ^\{\{([a-zA-Z0-9.\-_]+):([a-zA-Z0-9.\-_]+)\}\}$ minLength: 1 maxLength: 256 - type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 64 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfCustomVarNameValueDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfDayZeroCustomPropertyEncrypted_valOptionsDef' additionalProperties: false required: - mount_point - dayZeroFileContent additionalProperties: false interfaces: description: Interface name type: array uniqueItems: true minItems: 0 maxItems: 8 items: if: properties: sriov: properties: value: const: true then: required: - nicid - name else: required: - nicid type: object properties: name: description: Set network or interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_interfacesNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfInterfacesNameOptionsDef' nicid: description: Set Nicid type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 0 maximum: 65535 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_interfacesNicidDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfInterfacesNicidOptionsDef' sriov: description: Set sriov 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfInterfacesSriovOptionsDef' mode: description: 'Set type of switch port: access/trunk' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - access - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfModeOptionsDef' vlan: description: Set vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4094 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfVlanOptionsDef' additionalProperties: false additionalDisks: description: Additional disks type: array minItems: 0 maxItems: 2 items: type: object properties: disk_size: description: Set disk size type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 0 maximum: 2048000 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_disk_sizeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfAdditionalDisksDiskSizeOptionsDef' mount_path: description: Mount path type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_mount_pathDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_oneOfAdditionalDisksMount_pathOptionsDef' required: - disk_size additionalProperties: false required: - name - image - vcpus - memory_mb additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_SchemaPayload' examples: example_1: value: data: name: optionType: global value: xxx image: optionType: global value: xxx bootup_time: optionType: default value: -1 deployment_datastore: optionType: global value: xxx vcpus: optionType: global value: xxx memory_mb: optionType: global value: xxx root_disk_mb: optionType: global value: xxx dayZero: mount_point: optionType: global value: xxx dayZeroFileContent: optionType: global value: xxx customProperty: val: optionType: global value: xxx encrypted_val: optionType: global value: xxx interfaces: name: optionType: global value: xxx nicid: optionType: global value: xxx sriov: optionType: global value: xxx mode: optionType: global value: xxx vlan: optionType: global value: xxx name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksVnfAttributesVnfPostRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-write /v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}/vnf/{vnfId}: delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a VNF Profile Parcel for Networks feature profile operationId: DeleteNfvirtualVNFParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: vnfAttributesId in: path description: Profile Parcel ID required: true schema: 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}' type: string - name: vnfId in: path description: VNF Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-write get: tags: - Configuration - Feature Profile (NFVirtual) description: Get VNF Profile Parcels for Networks feature profile operationId: GetNfvirtualVNFParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: vnfAttributesId in: path description: Profile Parcel ID required: true schema: 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}' type: string - name: vnfId in: path description: VNF Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: name: description: Name of the VM to be deployed type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_nameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfNameOptionsDef' image: description: Name of the Image to be used for VM deployment type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_imageDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfImageOptionsDef' bootup_time: description: Boot up time for the VM type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: -1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_bootup_timeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfBootup_timeOptionsDef' deployment_datastore: description: Deployment datastore type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - datastore1 - datastore2 - datastore3 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_deployment_datastoreDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDeployment_datastoreOptionsDef' vcpus: description: Number of virtual cores for the Flavor type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 16 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_vcpusDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfVcpusOptionsDef' memory_mb: description: Memory in MB for the Flavor type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 256 maximum: 73728 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_memory_mbDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfMemory_mbOptionsDef' root_disk_mb: description: Root disk size in MB type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1024 maximum: 2048000 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_root_disk_mbDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfRoot_disk_mbOptionsDef' dayZero: description: DayZero file type: array uniqueItems: true items: type: object properties: mount_point: description: Destination for Day zero config file type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroMount_pointDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroMount_pointOptionsDef' dayZeroFileContent: description: Day zero config file type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroDayZeroFileContentDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroDayZeroFileContentOptionsDef' customProperty: description: custom property type: array uniqueItems: true items: type: object properties: name: description: Name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroCustomPropertyNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroCustomPropertyNameOptionsDef' val: description: Value type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroCustomPropertyValDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: oneOf: - type: string pattern: ^\{\{([a-zA-Z0-9.\-_]+):([a-zA-Z0-9.\-_]+)\}\}$ minLength: 1 maxLength: 256 - type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 64 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfCustomVarNameValueDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroCustomPropertyValOptionsDef' encrypted_val: description: Encrypted value type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroCustomPropertyEncrypted_valDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: oneOf: - type: string pattern: ^\{\{([a-zA-Z0-9.\-_]+):([a-zA-Z0-9.\-_]+)\}\}$ minLength: 1 maxLength: 256 - type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 64 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfCustomVarNameValueDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroCustomPropertyEncrypted_valOptionsDef' additionalProperties: false required: - mount_point - dayZeroFileContent additionalProperties: false interfaces: description: Interface name type: array uniqueItems: true minItems: 0 maxItems: 8 items: if: properties: sriov: properties: value: const: true then: required: - nicid - name else: required: - nicid type: object properties: name: description: Set network or interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_interfacesNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfInterfacesNameOptionsDef' nicid: description: Set Nicid type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 0 maximum: 65535 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_interfacesNicidDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfInterfacesNicidOptionsDef' sriov: description: Set sriov 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfInterfacesSriovOptionsDef' mode: description: 'Set type of switch port: access/trunk' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - access - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfModeOptionsDef' vlan: description: Set vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4094 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfVlanOptionsDef' additionalProperties: false additionalDisks: description: Additional disks type: array minItems: 0 maxItems: 2 items: type: object properties: disk_size: description: Set disk size type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 0 maximum: 2048000 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_disk_sizeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfAdditionalDisksDiskSizeOptionsDef' mount_path: description: Mount path type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_mount_pathDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfAdditionalDisksMount_pathOptionsDef' required: - disk_size additionalProperties: false required: - name - image - vcpus - memory_mb additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualNetworksVnfAttributesVnfPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: vnf-attributes/vnf createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: name: optionType: global value: xxx image: optionType: global value: xxx bootup_time: optionType: default value: -1 deployment_datastore: optionType: global value: xxx vcpus: optionType: global value: xxx memory_mb: optionType: global value: xxx root_disk_mb: optionType: global value: xxx dayZero: mount_point: optionType: global value: xxx dayZeroFileContent: optionType: global value: xxx customProperty: val: optionType: global value: xxx encrypted_val: optionType: global value: xxx interfaces: name: optionType: global value: xxx nicid: optionType: global value: xxx sriov: optionType: global value: xxx mode: optionType: global value: xxx vlan: optionType: global value: xxx $$ref: '#/components/examples/getSingleNfvirtualNetworksVnfAttributesVnfExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-read put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a VNF Profile Parcel for networks feature profile operationId: EditNfvirtualVNFParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: vnfAttributesId in: path description: Profile Parcel ID required: true schema: 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}' type: string - name: vnfId in: path description: VNF Parcel ID required: true schema: 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}' type: string requestBody: description: VNF Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: name: description: Name of the VM to be deployed type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_nameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfNameOptionsDef' image: description: Name of the Image to be used for VM deployment type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_imageDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfImageOptionsDef' bootup_time: description: Boot up time for the VM type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: -1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_bootup_timeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfBootup_timeOptionsDef' deployment_datastore: description: Deployment datastore type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - datastore1 - datastore2 - datastore3 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_deployment_datastoreDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDeployment_datastoreOptionsDef' vcpus: description: Number of virtual cores for the Flavor type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 16 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_vcpusDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfVcpusOptionsDef' memory_mb: description: Memory in MB for the Flavor type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 256 maximum: 73728 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_memory_mbDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfMemory_mbOptionsDef' root_disk_mb: description: Root disk size in MB type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1024 maximum: 2048000 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_root_disk_mbDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfRoot_disk_mbOptionsDef' dayZero: description: DayZero file type: array uniqueItems: true items: type: object properties: mount_point: description: Destination for Day zero config file type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroMount_pointDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroMount_pointOptionsDef' dayZeroFileContent: description: Day zero config file type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroDayZeroFileContentDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroDayZeroFileContentOptionsDef' customProperty: description: custom property type: array uniqueItems: true items: type: object properties: name: description: Name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroCustomPropertyNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroCustomPropertyNameOptionsDef' val: description: Value type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroCustomPropertyValDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: oneOf: - type: string pattern: ^\{\{([a-zA-Z0-9.\-_]+):([a-zA-Z0-9.\-_]+)\}\}$ minLength: 1 maxLength: 256 - type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 64 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfCustomVarNameValueDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroCustomPropertyValOptionsDef' encrypted_val: description: Encrypted value type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_dayZeroCustomPropertyEncrypted_valDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: oneOf: - type: string pattern: ^\{\{([a-zA-Z0-9.\-_]+):([a-zA-Z0-9.\-_]+)\}\}$ minLength: 1 maxLength: 256 - type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 64 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfCustomVarNameValueDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfDayZeroCustomPropertyEncrypted_valOptionsDef' additionalProperties: false required: - mount_point - dayZeroFileContent additionalProperties: false interfaces: description: Interface name type: array uniqueItems: true minItems: 0 maxItems: 8 items: if: properties: sriov: properties: value: const: true then: required: - nicid - name else: required: - nicid type: object properties: name: description: Set network or interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_interfacesNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfInterfacesNameOptionsDef' nicid: description: Set Nicid type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 0 maximum: 65535 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_interfacesNicidDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfInterfacesNicidOptionsDef' sriov: description: Set sriov 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfInterfacesSriovOptionsDef' mode: description: 'Set type of switch port: access/trunk' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - access - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfModeOptionsDef' vlan: description: Set vlan type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4094 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfVlanOptionsDef' additionalProperties: false additionalDisks: description: Additional disks type: array minItems: 0 maxItems: 2 items: type: object properties: disk_size: description: Set disk size type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 0 maximum: 2048000 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_disk_sizeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfAdditionalDisksDiskSizeOptionsDef' mount_path: description: Mount path type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_mount_pathDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_oneOfAdditionalDisksMount_pathOptionsDef' required: - disk_size additionalProperties: false required: - name - image - vcpus - memory_mb additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_SchemaPayload' examples: example_1: value: data: name: optionType: global value: xxx image: optionType: global value: xxx bootup_time: optionType: default value: -1 deployment_datastore: optionType: global value: xxx vcpus: optionType: global value: xxx memory_mb: optionType: global value: xxx root_disk_mb: optionType: global value: xxx dayZero: mount_point: optionType: global value: xxx dayZeroFileContent: optionType: global value: xxx customProperty: val: optionType: global value: xxx encrypted_val: optionType: global value: xxx interfaces: name: optionType: global value: xxx nicid: optionType: global value: xxx sriov: optionType: global value: xxx mode: optionType: global value: xxx vlan: optionType: global value: xxx name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksVnfAttributesVnfPutRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-write /v1/feature-profile/nfvirtual/networks/{networksId}/wan: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create a WAN Profile Parcel for Networks feature profile operationId: CreateNfvirtualWanParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: WAN config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: if: properties: dhcp: properties: value: const: false then: required: - color - interface_name - ip_address - netmask - type else: required: - color type: object properties: color: description: Color type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_colorDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfColorOptionsDef' interface_name: description: WAN interface or Port name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_wanInterfaceNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfWanInterfaceNameOptionsDef' network_name: description: Name of the WAN Network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_network_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfNetwork_nameOptionsDef' bridge: description: Name of the WAN Bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfBridgeOptionsDef' mode: description: Trunk or Access Mode of the Interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - trunk - access type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: enum: - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_defaultModeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfModeOptionsDef' dhcp: description: dhcp 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 - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: boolean enum: - false $$ref: '#/components/schemas/CommonCommonDefs_booleanFalseDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfDhcpOptionsDef' ip_address: description: IPv4 address on WAN interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_ipv4AddressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfIpv4AddressOptionsDef' netmask: description: subnet mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfNetmaskOptionsDef' shutdown: description: Shutdown for WAN Interface 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 - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: boolean enum: - false $$ref: '#/components/schemas/CommonCommonDefs_booleanFalseDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfShutdownOptionsDef' defaultGateway: description: Set Default Gateway type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_defaultGatewayDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfDefaultGatewayOptionsDef' type: description: Set admin distance type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - primary - secondary(1) - none $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_typeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfTypeOptionsDef' vlan: description: Range of VLANs for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfVlanOptionsDef' native_vlan: description: Native Vlan for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_native_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfNative_vlanOptionsDef' additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_SchemaPayload' examples: WANInterfaceParcelGlobalDefault: value: data: color: optionType: global value: xxx interface_name: optionType: global value: xxx network_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: trunk dhcp: optionType: default value: false ip_address: optionType: global value: xxx netmask: optionType: global value: xxx shutdown: optionType: default value: false defaultGateway: optionType: global value: xxx name: WANInterfaceParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksWanPostRequest_WANInterfaceParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Wan-write /v1/feature-profile/nfvirtual/networks/{networksId}/wan/{wanId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get WAN Profile Parcels for Networks feature profile operationId: GetNfvirtualWANParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: wanId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: if: properties: dhcp: properties: value: const: false then: required: - color - interface_name - ip_address - netmask - type else: required: - color type: object properties: color: description: Color type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_colorDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfColorOptionsDef' interface_name: description: WAN interface or Port name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_wanInterfaceNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfWanInterfaceNameOptionsDef' network_name: description: Name of the WAN Network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_network_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfNetwork_nameOptionsDef' bridge: description: Name of the WAN Bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfBridgeOptionsDef' mode: description: Trunk or Access Mode of the Interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - trunk - access type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: enum: - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_defaultModeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfModeOptionsDef' dhcp: description: dhcp 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 - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: boolean enum: - false $$ref: '#/components/schemas/CommonCommonDefs_booleanFalseDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfDhcpOptionsDef' ip_address: description: IPv4 address on WAN interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_ipv4AddressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfIpv4AddressOptionsDef' netmask: description: subnet mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfNetmaskOptionsDef' shutdown: description: Shutdown for WAN Interface 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 - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: boolean enum: - false $$ref: '#/components/schemas/CommonCommonDefs_booleanFalseDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfShutdownOptionsDef' defaultGateway: description: Set Default Gateway type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_defaultGatewayDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfDefaultGatewayOptionsDef' type: description: Set admin distance type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - primary - secondary(1) - none $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_typeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfTypeOptionsDef' vlan: description: Range of VLANs for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfVlanOptionsDef' native_vlan: description: Native Vlan for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_native_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfNative_vlanOptionsDef' additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualNetworksWanPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: wan createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: color: optionType: global value: xxx interface_name: optionType: global value: xxx network_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: trunk dhcp: optionType: default value: false ip_address: optionType: global value: xxx netmask: optionType: global value: xxx shutdown: optionType: default value: false defaultGateway: optionType: global value: xxx $$ref: '#/components/examples/getSingleNfvirtualNetworksWanExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Wan-read delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a WAN Profile Parcel for Networks feature profile operationId: DeleteNfvirtualWANParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: wanId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Wan-write put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a WAN Profile Parcel for networks feature profile operationId: EditNfvirtualWANParcel parameters: - name: networksId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: wanId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: WAN Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: if: properties: dhcp: properties: value: const: false then: required: - color - interface_name - ip_address - netmask - type else: required: - color type: object properties: color: description: Color type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - default - mpls - metro-ethernet - biz-internet - public-internet - lte - 3g - red - green - blue - gold - silver - bronze - custom1 - custom2 - custom3 - private1 - private2 - private3 - private4 - private5 - private6 type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_colorDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfColorOptionsDef' interface_name: description: WAN interface or Port name type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_wanInterfaceNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfWanInterfaceNameOptionsDef' network_name: description: Name of the WAN Network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 17 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_network_nameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfNetwork_nameOptionsDef' bridge: description: Name of the WAN Bridge type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string maxLength: 20 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_bridgeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfBridgeOptionsDef' mode: description: Trunk or Access Mode of the Interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - trunk - access type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_modeDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: enum: - trunk type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_defaultModeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfModeOptionsDef' dhcp: description: dhcp 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 - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: boolean enum: - false $$ref: '#/components/schemas/CommonCommonDefs_booleanFalseDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfDhcpOptionsDef' ip_address: description: IPv4 address on WAN interface type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_ipv4AddressDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfIpv4AddressOptionsDef' netmask: description: subnet mask type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - 255.255.255.255 - 255.255.255.254 - 255.255.255.252 - 255.255.255.248 - 255.255.255.240 - 255.255.255.224 - 255.255.255.192 - 255.255.255.128 - 255.255.255.0 - 255.255.254.0 - 255.255.252.0 - 255.255.248.0 - 255.255.240.0 - 255.255.224.0 - 255.255.192.0 - 255.255.128.0 - 255.255.0.0 - 255.254.0.0 - 255.252.0.0 - 255.248.0.0 - 255.240.0.0 - 255.224.0.0 - 255.192.0.0 - 255.128.0.0 - 255.0.0.0 - 254.0.0.0 - 252.0.0.0 - 248.0.0.0 - 240.0.0.0 - 224.0.0.0 - 192.0.0.0 - 128.0.0.0 - 0.0.0.0 $$ref: '#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfNetmaskOptionsDef' shutdown: description: Shutdown for WAN Interface 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 - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: boolean enum: - false $$ref: '#/components/schemas/CommonCommonDefs_booleanFalseDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfShutdownOptionsDef' defaultGateway: description: Set Default Gateway type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_defaultGatewayDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfDefaultGatewayOptionsDef' type: description: Set admin distance type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - primary - secondary(1) - none $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_typeDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfTypeOptionsDef' vlan: description: Range of VLANs for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string pattern: ((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?)) $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfVlanOptionsDef' native_vlan: description: Native Vlan for the network type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: integer minimum: 1 maximum: 4095 $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_native_vlanDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_oneOfNative_vlanOptionsDef' additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualNetworksWanPutRequest_SchemaPayload' examples: WANInterfaceParcelGlobalDefault: value: data: color: optionType: global value: xxx interface_name: optionType: global value: xxx network_name: optionType: global value: xxx bridge: optionType: global value: xxx mode: optionType: global value: trunk dhcp: optionType: default value: false ip_address: optionType: global value: xxx netmask: optionType: global value: xxx shutdown: optionType: default value: false defaultGateway: optionType: global value: xxx name: WANInterfaceParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualNetworksWanPutRequest_WANInterfaceParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual Networks > Wan-write /v1/feature-profile/nfvirtual/system: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get all Nfvirtual System Feature Profiles operationId: GetAllNfvirtualSystemFeatureProfiles parameters: - name: offset in: query description: Pagination offset schema: type: integer format: int32 - name: limit in: query description: Pagination limit schema: type: integer format: int32 default: 0 responses: '200': description: Success content: application/json: schema: type: array items: type: object properties: profileId: 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' profileName: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' profileType: type: string enum: - system 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 description: type: string solution: type: string enum: - nfvirtual $$ref: '#/components/schemas/getListNfvirtualSystemPayload' examples: get response example: value: - profileId: bc99ae4f-0ac3-4a51-95cb-c718953143ce profileName: cg1_LAN solution: nfvirtual profileType: system createdBy: admin lastUpdatedBy: admin createdOn: 1701850310222 description: cg1 system Profile lastUpdatedOn: 1702292120081 $$ref: '#/components/examples/getListNfvirtualSystemExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-read post: tags: - Configuration - Feature Profile (NFVirtual) description: Create a nfvirtual System Feature Profile operationId: CreateNfvirtualSystemFeatureProfile requestBody: description: Nfvirtual Feature profile content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string fromFeatureProfile: type: object description: from another feature profile oneOf: - properties: copy: 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' required: - copy additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPostRequest_fromFeatureProfileDef' required: - name - description additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPostRequest_SchemaPayload' examples: FeatureProfile-ConfigGroup1-NY: value: name: FeatureProfile-ConfigGroup1-NY description: Feature Profile for config group 1 for NY site $$ref: '#/components/examples/FeatureprofileCommonPostRequest_FeatureProfile-ConfigGroup1-NY' FeatureProfile-ConfigGroup1-COPY: value: name: FeatureProfile-ConfigGroup1-COPY description: Copy Feature Profile from EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99 fromFeatureProfile: copy: EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99 $$ref: '#/components/examples/FeatureprofileCommonPostRequest_FeatureProfile-ConfigGroup1-COPY' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPostResponse_SchemaPayload' examples: example_1: value: id: Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB $$ref: '#/components/examples/FeatureprofileCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-write /v1/feature-profile/nfvirtual/system/{systemId}: delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a Nfvirtual System Feature Profile operationId: DeleteNfvirtualSystemFeatureProfile parameters: - name: systemId in: path description: Feature Profile Id required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-write put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a Nfvirtual System Feature Profile operationId: EditNfvirtualSystemFeatureProfile parameters: - name: systemId in: path description: Feature Profile Id required: true schema: 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}' type: string requestBody: description: Nfvirtual Feature profile content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string required: - name - description additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPutRequest_SchemaPayload' examples: FeatureProfile-ConfigGroup1-NY: value: name: FeatureProfile-ConfigGroup1-NY description: Feature Profile for config group 1 for NY site $$ref: '#/components/examples/FeatureprofileCommonPutRequest_FeatureProfile-ConfigGroup1-NY' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id additionalProperties: false $$ref: '#/components/schemas/FeatureprofileCommonPutResponse_SchemaPayload' examples: example_1: value: id: Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB $$ref: '#/components/examples/FeatureprofileCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-write get: tags: - Configuration - Feature Profile (NFVirtual) description: Get a Nfvirtual System Feature Profile with systemId operationId: GetNfvirtualSystemFeatureProfileByProfileId parameters: - name: systemId in: path description: Feature Profile Id required: true schema: 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}' type: string responses: '200': description: Success content: application/json: schema: type: object properties: profileId: 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' profileType: type: string enum: - system profileName: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string solution: type: string enum: - nfvirtual 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 associatedProfileParcels: type: array items: type: object minItems: 0 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 payload: type: object subparcels: type: array minItems: 0 items: type: object $$ref: '#/components/schemas/getSingleNfvirtualSystemPayload' examples: get response example: value: profileName: cg1_LAN lastUpdatedBy: admin description: cg1 system Profile profileParcelCount: 613 createdOn: 1701850310222 '@rid': 3262 profileType: system solution: nfvirtual createdBy: admin profileId: bc99ae4f-0ac3-4a51-95cb-c718953143ce lastUpdatedOn: 1702292120081 associatedProfileParcels: [] $$ref: '#/components/examples/getSingleNfvirtualSystemExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System-read /v1/feature-profile/nfvirtual/system/{systemId}/aaa: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create AAA Profile Parcel for System feature profile operationId: CreateNfvirtualAAAParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: AAA config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: user: description: Create local login account type: array uniqueItems: true minItems: 1 items: type: object properties: name: description: Set the username type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_userNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfUserNameOptionsDef' nfvisPassword: description: Set the user password type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_userPasswordDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfUserPasswordOptionsDef' role: description: Set Role for this user type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - administrators - operators - auditors type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_userRoleDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfUserRoleOptionsDef' required: - name - nfvisPassword - role additionalProperties: false auth-order: description: Set order to try different authentication methods type: array uniqueItems: true maxItems: 2 items: type: object properties: authentication: description: Authentication method type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - local - tacacs type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_authOrderAuthenticationDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfAuthOrderAuthenticationOptionsDef' required: - authentication additionalProperties: false tacacs: description: Configure the TACACS server type: array uniqueItems: true maxItems: 4 items: type: object properties: host: description: Set IP address of TACACS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - format: hostname $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_tacacsHostDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfTacacsHostOptionsDef' key: description: Set Key for Tacacs type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '0' enum: - '0' - '7' type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_tacacsKeyEnumDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - '0' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfTacacsKeyEnumOptionsDef' shared-secret: description: Shared Secret for TACACS type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 maxLength: 127 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_tacacsSharedSecretDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfTacacsSharedSecretOptionsDef' admin-priv: description: Admin Privileges of TACACS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 15 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_tacacsAdminPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 15 maximum: 15 minimum: 15 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfTacacsAdminPrivOptionsDef' oper-priv: description: Oper Privileges the TACACS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 11 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_tacacsOperPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 11 maximum: 11 minimum: 11 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfTacacsOperPrivOptionsDef' required: - host - shared-secret additionalProperties: false radius: description: Configure the RADIUS server type: array uniqueItems: true maxItems: 4 items: type: object properties: host: description: Set IP address of RADIUS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - format: hostname $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_radiusHostDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfRadiusHostOptionsDef' key: description: Set Key for RADIUS type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '0' enum: - '0' - '7' type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_radiusKeyEnumDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - '0' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfRadiusKeyEnumOptionsDef' shared-secret: description: Shared Secret for RADIUS type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 maxLength: 127 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_radiusSharedSecretDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfRadiusSharedSecretOptionsDef' admin-priv: description: Admin Privileges of RADIUS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 15 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_radiusAdminPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 15 maximum: 15 minimum: 15 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfRadiusAdminPrivOptionsDef' oper-priv: description: Oper Privileges the RADIUS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 11 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_radiusOperPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 11 maximum: 11 minimum: 11 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_oneOfRadiusOperPrivOptionsDef' required: - host - shared-secret additionalProperties: false required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.16.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPostRequest_SchemaPayload' examples: example_1: value: data: user: name: optionType: global value: xxx nfvisPassword: optionType: global value: xxx privilege: optionType: default value: '15' auth-order: authentication: optionType: global value: xxx tacacs: host: optionType: global value: xxx key: optionType: global value: xxx shared-secret: optionType: global value: xxx admin-priv: optionType: global value: xxx oper-priv: optionType: global value: xxx radius: host: optionType: global value: xxx key: optionType: global value: xxx shared-secret: optionType: global value: xxx admin-priv: optionType: global value: xxx oper-priv: optionType: global value: xxx name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualSystemAaaPostRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Aaa-write /v1/feature-profile/nfvirtual/system/{systemId}/aaa/{aaaId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get AAA Profile Parcels for System feature profile operationId: GetNfvirtualAAAParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: aaaId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: user: description: Create local login account type: array uniqueItems: true minItems: 1 items: type: object properties: name: description: Set the username type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_userNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfUserNameOptionsDef' nfvisPassword: description: Set the user password type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_userPasswordDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfUserPasswordOptionsDef' role: description: Set Role for this user type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - administrators - operators - auditors type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_userRoleDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfUserRoleOptionsDef' required: - name - nfvisPassword - role additionalProperties: false auth-order: description: Set order to try different authentication methods type: array uniqueItems: true maxItems: 2 items: type: object properties: authentication: description: Authentication method type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - local - tacacs type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_authOrderAuthenticationDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfAuthOrderAuthenticationOptionsDef' required: - authentication additionalProperties: false tacacs: description: Configure the TACACS server type: array uniqueItems: true maxItems: 4 items: type: object properties: host: description: Set IP address of TACACS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - format: hostname $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsHostDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsHostOptionsDef' key: description: Set Key for Tacacs type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '0' enum: - '0' - '7' type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsKeyEnumDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - '0' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsKeyEnumOptionsDef' shared-secret: description: Shared Secret for TACACS type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 maxLength: 127 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsSharedSecretDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsSharedSecretOptionsDef' admin-priv: description: Admin Privileges of TACACS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 15 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsAdminPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 15 maximum: 15 minimum: 15 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsAdminPrivOptionsDef' oper-priv: description: Oper Privileges the TACACS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 11 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsOperPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 11 maximum: 11 minimum: 11 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsOperPrivOptionsDef' required: - host - shared-secret additionalProperties: false radius: description: Configure the RADIUS server type: array uniqueItems: true maxItems: 4 items: type: object properties: host: description: Set IP address of RADIUS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - format: hostname $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusHostDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusHostOptionsDef' key: description: Set Key for RADIUS type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '0' enum: - '0' - '7' type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusKeyEnumDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - '0' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusKeyEnumOptionsDef' shared-secret: description: Shared Secret for RADIUS type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 maxLength: 127 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusSharedSecretDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusSharedSecretOptionsDef' admin-priv: description: Admin Privileges of RADIUS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 15 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusAdminPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 15 maximum: 15 minimum: 15 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusAdminPrivOptionsDef' oper-priv: description: Oper Privileges the RADIUS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 11 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusOperPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 11 maximum: 11 minimum: 11 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusOperPrivOptionsDef' required: - host - shared-secret additionalProperties: false required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.16.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualSystemAaaPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: aaa createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: user: name: optionType: global value: xxx nfvisPassword: optionType: global value: xxx privilege: optionType: default value: '15' auth-order: authentication: optionType: global value: xxx tacacs: host: optionType: global value: xxx key: optionType: global value: xxx shared-secret: optionType: global value: xxx admin-priv: optionType: global value: xxx oper-priv: optionType: global value: xxx radius: host: optionType: global value: xxx key: optionType: global value: xxx shared-secret: optionType: global value: xxx admin-priv: optionType: global value: xxx oper-priv: optionType: global value: xxx $$ref: '#/components/examples/getSingleNfvirtualSystemAaaExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Aaa-read put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a AAA Profile Parcel for System feature profile operationId: EditNfvirtualAAAParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: aaaId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: AAA Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: user: description: Create local login account type: array uniqueItems: true minItems: 1 items: type: object properties: name: description: Set the username type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_userNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfUserNameOptionsDef' nfvisPassword: description: Set the user password type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_userPasswordDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfUserPasswordOptionsDef' role: description: Set Role for this user type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - administrators - operators - auditors type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_userRoleDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfUserRoleOptionsDef' required: - name - nfvisPassword - role additionalProperties: false auth-order: description: Set order to try different authentication methods type: array uniqueItems: true maxItems: 2 items: type: object properties: authentication: description: Authentication method type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - local - tacacs type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_authOrderAuthenticationDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfAuthOrderAuthenticationOptionsDef' required: - authentication additionalProperties: false tacacs: description: Configure the TACACS server type: array uniqueItems: true maxItems: 4 items: type: object properties: host: description: Set IP address of TACACS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - format: hostname $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsHostDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsHostOptionsDef' key: description: Set Key for Tacacs type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '0' enum: - '0' - '7' type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsKeyEnumDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - '0' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsKeyEnumOptionsDef' shared-secret: description: Shared Secret for TACACS type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 maxLength: 127 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsSharedSecretDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsSharedSecretOptionsDef' admin-priv: description: Admin Privileges of TACACS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 15 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsAdminPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 15 maximum: 15 minimum: 15 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsAdminPrivOptionsDef' oper-priv: description: Oper Privileges the TACACS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 11 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_tacacsOperPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 11 maximum: 11 minimum: 11 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfTacacsOperPrivOptionsDef' required: - host - shared-secret additionalProperties: false radius: description: Configure the RADIUS server type: array uniqueItems: true maxItems: 4 items: type: object properties: host: description: Set IP address of RADIUS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - format: hostname $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusHostDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusHostOptionsDef' key: description: Set Key for RADIUS type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '0' enum: - '0' - '7' type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusKeyEnumDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - '0' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusKeyEnumOptionsDef' shared-secret: description: Shared Secret for RADIUS type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 maxLength: 127 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusSharedSecretDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusSharedSecretOptionsDef' admin-priv: description: Admin Privileges of RADIUS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 15 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusAdminPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 15 maximum: 15 minimum: 15 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusAdminPrivOptionsDef' oper-priv: description: Oper Privileges the RADIUS server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 11 maximum: 15 minimum: 1 type: integer $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_radiusOperPrivDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: integer default: 11 maximum: 11 minimum: 11 required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_oneOfRadiusOperPrivOptionsDef' required: - host - shared-secret additionalProperties: false required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.16.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemAaaPutRequest_SchemaPayload' examples: example_1: value: data: user: name: optionType: global value: xxx nfvisPassword: optionType: global value: xxx privilege: optionType: default value: '15' auth-order: authentication: optionType: global value: xxx tacacs: host: optionType: global value: xxx key: optionType: global value: xxx shared-secret: optionType: global value: xxx admin-priv: optionType: global value: xxx oper-priv: optionType: global value: xxx radius: host: optionType: global value: xxx key: optionType: global value: xxx shared-secret: optionType: global value: xxx admin-priv: optionType: global value: xxx oper-priv: optionType: global value: xxx name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualSystemAaaPutRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Aaa-write delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a AAA Profile Parcel for System feature profile operationId: DeleteNfvirtualAAAParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: aaaId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Aaa-write /v1/feature-profile/nfvirtual/system/{systemId}/banner: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create Banner Profile Parcel for System feature profile operationId: CreateNfvirtualBannerParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: Banner config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: login: description: Set message to display before login prompt type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPostRequest_loginDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPostRequest_oneOfLoginOptionsDef' motd: description: Set message to display after a user logs in type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPostRequest_motdDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPostRequest_oneOfMotdOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPostRequest_SchemaPayload' examples: example_1: value: data: login: optionType: global value: xxx motd: optionType: global value: xxx name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualSystemBannerPostRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Banner-write /v1/feature-profile/nfvirtual/system/{systemId}/banner/{bannerId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get Banner Profile Parcels for System feature profile operationId: GetNfvirtualBannerParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: bannerId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: login: description: Set message to display before login prompt type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_loginDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_oneOfLoginOptionsDef' motd: description: Set message to display after a user logs in type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_motdDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_oneOfMotdOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualSystemBannerPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: banner createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: login: optionType: global value: xxx motd: optionType: global value: xxx $$ref: '#/components/examples/getSingleNfvirtualSystemBannerExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Banner-read delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a Banner Profile Parcel for System feature profile operationId: DeleteNfvirtualBannerParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: bannerId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Banner-write put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a Banner Profile Parcel for System feature profile operationId: EditNfvirtualBannerParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: bannerId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: Banner Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: login: description: Set message to display before login prompt type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_loginDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_oneOfLoginOptionsDef' motd: description: Set message to display after a user logs in type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_motdDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_oneOfMotdOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemBannerPutRequest_SchemaPayload' examples: example_1: value: data: login: optionType: global value: xxx motd: optionType: global value: xxx name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualSystemBannerPutRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Banner-write /v1/feature-profile/nfvirtual/system/{systemId}/logging: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create Logging Profile Parcel for System feature profile operationId: CreateNfvirtualLoggingParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: Logging config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: host-ip-address: description: Enable logging to remote server type: array uniqueItems: true minItems: 0 maxItems: 4 items: type: object properties: name: description: Set hostname or IPv4 address of server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - format: hostname $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPostRequest_hostIpAddressNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPostRequest_oneOfHostIpAddressNameOptionsDef' required: - name additionalProperties: false severity: description: Set logging level for messages logged type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: information enum: - emergency - alert - critical - error - warn - notice - information - debug type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPostRequest_severityDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - information $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPostRequest_defaultSeverityDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPostRequest_oneOfSeverityOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPostRequest_SchemaPayload' examples: example_1: value: data: host-ip-address: name: optionType: global value: xxx severity: optionType: default value: information name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualSystemLoggingPostRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Logging-write /v1/feature-profile/nfvirtual/system/{systemId}/logging/{loggingId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get Logging Profile Parcels for System feature profile operationId: GetNfvirtualLoggingParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: loggingId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: host-ip-address: description: Enable logging to remote server type: array uniqueItems: true minItems: 0 maxItems: 4 items: type: object properties: name: description: Set hostname or IPv4 address of server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_hostIpAddressNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_oneOfHostIpAddressNameOptionsDef' required: - name additionalProperties: false severity: description: Set logging level for messages logged type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: information enum: - emergency - alert - critical - error - warn - notice - information - debug type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_severityDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - information $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_defaultSeverityDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_oneOfSeverityOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualSystemLoggingPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: logging createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: host-ip-address: name: optionType: global value: xxx severity: optionType: default value: information $$ref: '#/components/examples/getSingleNfvirtualSystemLoggingExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Logging-read put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a Logging Profile Parcel for System feature profile operationId: EditNfvirtualLoggingParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: loggingId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: Logging Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: host-ip-address: description: Enable logging to remote server type: array uniqueItems: true minItems: 0 maxItems: 4 items: type: object properties: name: description: Set hostname or IPv4 address of server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_hostIpAddressNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_oneOfHostIpAddressNameOptionsDef' required: - name additionalProperties: false severity: description: Set logging level for messages logged type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: information enum: - emergency - alert - critical - error - warn - notice - information - debug type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_severityDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - information $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_defaultSeverityDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_oneOfSeverityOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemLoggingPutRequest_SchemaPayload' examples: example_1: value: data: host-ip-address: name: optionType: global value: xxx severity: optionType: default value: information name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualSystemLoggingPutRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Logging-write delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a Logging Profile Parcel for System feature profile operationId: DeleteNfvirtualLoggingParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: loggingId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Logging-write /v1/feature-profile/nfvirtual/system/{systemId}/ntp: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create NTP Profile Parcel for System feature profile operationId: CreateNfvirtualNTPParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: NTP config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: preferred_server: description: Set Preferred server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - pattern: ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. minLength: 1 maxLength: 253 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPostRequest_preferred_serverDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPostRequest_oneOfPreferred_serverOptionsDef' backup_server: description: Set up back up server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - pattern: ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. minLength: 1 maxLength: 253 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPostRequest_backup_serverDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPostRequest_oneOfBackup_serverOptionsDef' required: - preferred_server additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPostRequest_SchemaPayload' examples: NtpParcelGlobalDefault: value: data: preferred_server: optionType: global value: xxx backup_server: optionType: global value: xxx name: NtpParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualSystemNtpPostRequest_NtpParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Ntp-write /v1/feature-profile/nfvirtual/system/{systemId}/ntp/{ntpId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get NTP Profile Parcels for System feature profile operationId: GetNfvirtualNTPParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: ntpId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: preferred_server: description: Set Preferred server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - pattern: ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. minLength: 1 maxLength: 253 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_preferred_serverDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_oneOfPreferred_serverOptionsDef' backup_server: description: Set up back up server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - pattern: ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. minLength: 1 maxLength: 253 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_backup_serverDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_oneOfBackup_serverOptionsDef' required: - preferred_server additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualSystemNtpPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: ntp createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: preferred_server: optionType: global value: xxx backup_server: optionType: global value: xxx $$ref: '#/components/examples/getSingleNfvirtualSystemNtpExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Ntp-read put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a NTP Profile Parcel for System feature profile operationId: EditNfvirtualNTPParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: ntpId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: NTP Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: preferred_server: description: Set Preferred server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - pattern: ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. minLength: 1 maxLength: 253 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_preferred_serverDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_oneOfPreferred_serverOptionsDef' backup_server: description: Set up back up server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string anyOf: - format: ipv4 - pattern: ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. minLength: 1 maxLength: 253 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_backup_serverDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_oneOfBackup_serverOptionsDef' required: - preferred_server additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemNtpPutRequest_SchemaPayload' examples: NtpParcelGlobalDefault: value: data: preferred_server: optionType: global value: xxx backup_server: optionType: global value: xxx name: NtpParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualSystemNtpPutRequest_NtpParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Ntp-write delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a NTP Profile Parcel for System feature profile operationId: DeleteNfvirtualNTPParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: ntpId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Ntp-write /v1/feature-profile/nfvirtual/system/{systemId}/snmp: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create SNMP Profile Parcel for System feature profile operationId: CreateNfvirtualSNMPParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: SNMP config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: community: description: Configure SNMP community type: array uniqueItems: true maxItems: 10 items: type: object properties: communityName: description: Set name of the SNMP community type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_communityNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfCommunityNameOptionsDef' communityAccess: description: community access SNMP community type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: readOnly type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_communityCommunityAccessDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfCommunityCommunityAccessOptionsDef' required: - communityName additionalProperties: false group: description: Configure an SNMP group type: array uniqueItems: true maxItems: 10 items: type: object properties: name: description: Name of the SNMP group type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_groupNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfGroupNameOptionsDef' context: description: context type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmp minLength: 1 type: string maxLength: 32 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_groupContextDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfGroupContextOptionsDef' version: description: version type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '1' type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.group[*].version.value values: - '1' - '2' description: SNMPv3 groups with authentication and privacy provide stronger security. reason: SNMP version 1 and v2c groups with noAuthNoPriv, authNoPriv are insecure. remediation: SNMPv3 groups with authentication and privacy provide stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_groupVersionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfGroupVersionOptionsDef' securityLevel: description: Configure security level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: noAuthNoPriv type: string enum: - noAuthNoPriv - authNoPriv - authPriv x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.group[*].securityLevel.value values: - noAuthNoPriv - authNoPriv description: SNMPv3 groups with authentication and privacy provide stronger security. reason: SNMP version 1 and v2c groups with noAuthNoPriv, authNoPriv are insecure. remediation: SNMPv3 groups with authentication and privacy provide stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_groupSecurityLevelDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfGroupSecurityLevelOptionsDef' notify: description: Configure notify level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmpNotify type: string pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_groupNotifyDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfGroupNotifyOptionsDef' read: description: Configure notify level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmpRead type: string pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_groupReadDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfGroupReadOptionsDef' write: description: Configure write level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmpWrite type: string pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_groupWriteDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfGroupWriteOptionsDef' required: - name - securityLevel - context additionalProperties: false user: description: Configure an SNMP user type: array uniqueItems: true maxItems: 10 items: type: object properties: userName: description: Name of the SNMP user type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_userUserNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfUserUserNameOptionsDef' version: description: 'Configure version ' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '1' type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].version.value values: - '1' - '2' description: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. reason: SNMP v1 or SNMP v2 configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication. remediation: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_userVersionDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - '1' x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].version.value values: - '1' - '2' description: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. reason: SNMP v1 or SNMP v2 configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication. remediation: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_defaultUserVersionDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfUserVersionOptionsDef' userGroup: description: Name of the SNMP group type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_userUserGroupDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfUserUserGroupOptionsDef' authProtocol: description: Configure authentication protocol type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - md5 - sha - sha256 type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].authProtocol.value values: - md5 - sha description: SHA256 authentication provides stronger security. reason: MD5, SHA1 authentication protocol is cryptographically weak and vulnerable to collision attacks. remediation: SHA256 authentication provides stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_userAuthProtocolDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfUserAuthProtocolOptionsDef' privProtocol: description: Configure privacy protocol type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - aes - des type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].privProtocol.value values: - des description: AES encryption provides stronger security. reason: DES encryption is considered weak and insecure. remediation: AES encryption provides stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_userPrivProtocolDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfUserPrivProtocolOptionsDef' passphrase: description: Specify passphrase type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minimum: 8 type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_userPassphraseDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfUserPassphraseOptionsDef' required: - userName - version - userGroup additionalProperties: false host: description: Configure SNMP server to receive SNMP traps type: array uniqueItems: true maxItems: 4 items: type: object properties: hostName: description: Set host name for  SNMP server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 maxLength: 32 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_hostHostNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfHostHostNameOptionsDef' ip: description: Set IPv4 address of SNMP server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_hostIpDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfHostIpOptionsDef' port: description: Set host port number to connect to SNMP server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 162 type: integer minimum: 0 maximum: 65535 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_hostPortDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfHostPortOptionsDef' hostUserName: description: Set name of the SNMP user type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_hostHostUserNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfHostHostUserNameOptionsDef' hostVersion: description: Set version of the SNMP host type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '1' type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_hostHostVersionDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfHostHostVersionOptionsDef' hostSecurityLevel: description: Host security level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - noAuthNoPriv - authNoPriv - authPriv $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_hostHostSecurityLevelDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfHostHostSecurityLevelOptionsDef' required: - hostName - ip - port - hostUserName - hostVersion - hostSecurityLevel additionalProperties: false linkUp: description: SNMP Trap LinkUp 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfLinkUpOptionsDef' linkDown: description: SNMP Trap LinkDown 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_oneOfLinkDownOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPostRequest_SchemaPayload' examples: example_1: value: data: community: name: optionType: global value: xxx communityAccess: optionType: default value: readOnly group: name: optionType: global value: xxx context: optionType: default value: snmp version: optionType: default value: '1' securityLevel: optionType: default value: noAuthNoPriv notify: optionType: default value: snmpNotify read: optionType: default value: snmpRead write: optionType: default value: snmpWrite user: userName: optionType: global value: xxx version: optionType: default value: '1' userGroup: optionType: global value: xxx authProtocol: optionType: global value: xxx privProtocol: optionType: global value: xxx passphrase: optionType: global value: xxx host: hostName: optionType: global value: xxx ip: optionType: global value: xxx port: optionType: default value: 162 hostUserName: optionType: global value: xxx hostVersion: optionType: default value: '1' hostSecurityLevel: optionType: global value: xxx linkUp: optionType: default value: false linkDown: optionType: default value: false name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualSystemSnmpPostRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Snmp-write /v1/feature-profile/nfvirtual/system/{systemId}/snmp/{snmpId}: get: tags: - Configuration - Feature Profile (NFVirtual) description: Get SNMP Profile Parcels for System feature profile operationId: GetNfvirtualSNMPParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: snmpId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: community: description: Configure SNMP community type: array uniqueItems: true maxItems: 10 items: type: object properties: communityName: description: Set name of the SNMP community type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_communityNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfCommunityNameOptionsDef' communityAccess: description: community access SNMP community type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: readOnly type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_communityCommunityAccessDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfCommunityCommunityAccessOptionsDef' required: - communityName additionalProperties: false group: description: Configure an SNMP group type: array uniqueItems: true maxItems: 10 items: type: object properties: name: description: Name of the SNMP group type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupNameOptionsDef' context: description: context type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmp minLength: 1 type: string maxLength: 32 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupContextDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupContextOptionsDef' version: description: version type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '1' type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.group[*].version.value values: - '1' - '2' description: SNMPv3 groups with authentication and privacy provide stronger security. reason: SNMP version 1 and v2c groups with noAuthNoPriv, authNoPriv are insecure. remediation: SNMPv3 groups with authentication and privacy provide stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupVersionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupVersionOptionsDef' securityLevel: description: Configure security level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: noAuthNoPriv type: string enum: - noAuthNoPriv - authNoPriv - authPriv x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.group[*].securityLevel.value values: - noAuthNoPriv - authNoPriv description: SNMPv3 groups with authentication and privacy provide stronger security. reason: SNMP version 1 and v2c groups with noAuthNoPriv, authNoPriv are insecure. remediation: SNMPv3 groups with authentication and privacy provide stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupSecurityLevelDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupSecurityLevelOptionsDef' notify: description: Configure notify level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmpNotify type: string pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupNotifyDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupNotifyOptionsDef' read: description: Configure notify level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmpRead type: string pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupReadDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupReadOptionsDef' write: description: Configure write level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmpWrite type: string pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupWriteDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupWriteOptionsDef' required: - name - securityLevel - context additionalProperties: false user: description: Configure an SNMP user type: array uniqueItems: true maxItems: 10 items: type: object properties: userName: description: Name of the SNMP user type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userUserNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserUserNameOptionsDef' version: description: 'Configure version ' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '1' type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].version.value values: - '1' - '2' description: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. reason: SNMP v1 or SNMP v2 configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication. remediation: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userVersionDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - '1' x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].version.value values: - '1' - '2' description: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. reason: SNMP v1 or SNMP v2 configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication. remediation: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_defaultUserVersionDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserVersionOptionsDef' userGroup: description: Name of the SNMP group type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userUserGroupDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserUserGroupOptionsDef' authProtocol: description: Configure authentication protocol type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - md5 - sha - sha256 type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].authProtocol.value values: - md5 - sha description: SHA256 authentication provides stronger security. reason: MD5, SHA1 authentication protocol is cryptographically weak and vulnerable to collision attacks. remediation: SHA256 authentication provides stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userAuthProtocolDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserAuthProtocolOptionsDef' privProtocol: description: Configure privacy protocol type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - aes - des type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].privProtocol.value values: - des description: AES encryption provides stronger security. reason: DES encryption is considered weak and insecure. remediation: AES encryption provides stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userPrivProtocolDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserPrivProtocolOptionsDef' passphrase: description: Specify passphrase type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minimum: 8 type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userPassphraseDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserPassphraseOptionsDef' required: - userName - version - userGroup additionalProperties: false host: description: Configure SNMP server to receive SNMP traps type: array uniqueItems: true maxItems: 4 items: type: object properties: hostName: description: Set host name for  SNMP server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 maxLength: 32 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostHostNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostHostNameOptionsDef' ip: description: Set IPv4 address of SNMP server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostIpDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostIpOptionsDef' port: description: Set host port number to connect to SNMP server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 162 type: integer minimum: 0 maximum: 65535 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostPortDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostPortOptionsDef' hostUserName: description: Set name of the SNMP user type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostHostUserNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostHostUserNameOptionsDef' hostVersion: description: Set version of the SNMP host type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '1' type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostHostVersionDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostHostVersionOptionsDef' hostSecurityLevel: description: Host security level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - noAuthNoPriv - authNoPriv - authPriv $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostHostSecurityLevelDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostHostSecurityLevelOptionsDef' required: - hostName - ip - port - hostUserName - hostVersion - hostSecurityLevel additionalProperties: false linkUp: description: SNMP Trap LinkUp 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfLinkUpOptionsDef' linkDown: description: SNMP Trap LinkDown 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfLinkDownOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualSystemSnmpPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: snmp createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: community: name: optionType: global value: xxx communityAccess: optionType: default value: readOnly group: name: optionType: global value: xxx context: optionType: default value: snmp version: optionType: default value: '1' securityLevel: optionType: default value: noAuthNoPriv notify: optionType: default value: snmpNotify read: optionType: default value: snmpRead write: optionType: default value: snmpWrite user: userName: optionType: global value: xxx version: optionType: default value: '1' userGroup: optionType: global value: xxx authProtocol: optionType: global value: xxx privProtocol: optionType: global value: xxx passphrase: optionType: global value: xxx host: hostName: optionType: global value: xxx ip: optionType: global value: xxx port: optionType: default value: 162 hostUserName: optionType: global value: xxx hostVersion: optionType: default value: '1' hostSecurityLevel: optionType: global value: xxx linkUp: optionType: default value: false linkDown: optionType: default value: false $$ref: '#/components/examples/getSingleNfvirtualSystemSnmpExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Snmp-read delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete a SNMP Profile Parcel for System feature profile operationId: DeleteNfvirtualSNMPParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: snmpId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Snmp-write put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a SNMP Profile Parcel for System feature profile operationId: EditNfvirtualSNMPParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: snmpId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: SNMP Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: community: description: Configure SNMP community type: array uniqueItems: true maxItems: 10 items: type: object properties: communityName: description: Set name of the SNMP community type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_communityNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfCommunityNameOptionsDef' communityAccess: description: community access SNMP community type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: readOnly type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_communityCommunityAccessDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfCommunityCommunityAccessOptionsDef' required: - communityName additionalProperties: false group: description: Configure an SNMP group type: array uniqueItems: true maxItems: 10 items: type: object properties: name: description: Name of the SNMP group type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupNameOptionsDef' context: description: context type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmp minLength: 1 type: string maxLength: 32 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupContextDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupContextOptionsDef' version: description: version type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '1' type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.group[*].version.value values: - '1' - '2' description: SNMPv3 groups with authentication and privacy provide stronger security. reason: SNMP version 1 and v2c groups with noAuthNoPriv, authNoPriv are insecure. remediation: SNMPv3 groups with authentication and privacy provide stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupVersionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupVersionOptionsDef' securityLevel: description: Configure security level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: noAuthNoPriv type: string enum: - noAuthNoPriv - authNoPriv - authPriv x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.group[*].securityLevel.value values: - noAuthNoPriv - authNoPriv description: SNMPv3 groups with authentication and privacy provide stronger security. reason: SNMP version 1 and v2c groups with noAuthNoPriv, authNoPriv are insecure. remediation: SNMPv3 groups with authentication and privacy provide stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupSecurityLevelDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupSecurityLevelOptionsDef' notify: description: Configure notify level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmpNotify type: string pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupNotifyDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupNotifyOptionsDef' read: description: Configure notify level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmpRead type: string pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupReadDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupReadOptionsDef' write: description: Configure write level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: snmpWrite type: string pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_groupWriteDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfGroupWriteOptionsDef' required: - name - securityLevel - context additionalProperties: false user: description: Configure an SNMP user type: array uniqueItems: true maxItems: 10 items: type: object properties: userName: description: Name of the SNMP user type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userUserNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserUserNameOptionsDef' version: description: 'Configure version ' type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '1' type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].version.value values: - '1' - '2' description: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. reason: SNMP v1 or SNMP v2 configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication. remediation: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userVersionDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: string enum: - '1' x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].version.value values: - '1' - '2' description: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. reason: SNMP v1 or SNMP v2 configured - legacy protocol poses data confidentiality and integrity risks due to lack of encryption and authentication. remediation: Configure SNMPv3. This is the secure alternative for SNMPv1 or SNMPv2. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_defaultUserVersionDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserVersionOptionsDef' userGroup: description: Name of the SNMP group type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 pattern: '[A-Za-z0-9_-]+' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userUserGroupDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserUserGroupOptionsDef' authProtocol: description: Configure authentication protocol type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - md5 - sha - sha256 type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].authProtocol.value values: - md5 - sha description: SHA256 authentication provides stronger security. reason: MD5, SHA1 authentication protocol is cryptographically weak and vulnerable to collision attacks. remediation: SHA256 authentication provides stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userAuthProtocolDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserAuthProtocolOptionsDef' privProtocol: description: Configure privacy protocol type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: enum: - aes - des type: string x-attributeMetadata: insecureConfiguration: attributeJsonPath: $.data.user[*].privProtocol.value values: - des description: AES encryption provides stronger security. reason: DES encryption is considered weak and insecure. remediation: AES encryption provides stronger security. $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userPrivProtocolDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserPrivProtocolOptionsDef' passphrase: description: Specify passphrase type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minimum: 8 type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_userPassphraseDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfUserPassphraseOptionsDef' required: - userName - version - userGroup additionalProperties: false host: description: Configure SNMP server to receive SNMP traps type: array uniqueItems: true maxItems: 4 items: type: object properties: hostName: description: Set host name for  SNMP server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 maxLength: 32 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostHostNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostHostNameOptionsDef' ip: description: Set IPv4 address of SNMP server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string minLength: 1 anyOf: - format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostIpDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostIpOptionsDef' port: description: Set host port number to connect to SNMP server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: 162 type: integer minimum: 0 maximum: 65535 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostPortDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostPortOptionsDef' hostUserName: description: Set name of the SNMP user type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: minLength: 1 type: string maxLength: 32 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostHostUserNameDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostHostUserNameOptionsDef' hostVersion: description: Set version of the SNMP host type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: default: '1' type: string $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostHostVersionDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostHostVersionOptionsDef' hostSecurityLevel: description: Host security level type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string enum: - noAuthNoPriv - authNoPriv - authPriv $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_hostHostSecurityLevelDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfHostHostSecurityLevelOptionsDef' required: - hostName - ip - port - hostUserName - hostVersion - hostSecurityLevel additionalProperties: false linkUp: description: SNMP Trap LinkUp 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfLinkUpOptionsDef' linkDown: description: SNMP Trap LinkDown 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 - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_oneOfLinkDownOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSnmpPutRequest_SchemaPayload' examples: example_1: value: data: community: name: optionType: global value: xxx communityAccess: optionType: default value: readOnly group: name: optionType: global value: xxx context: optionType: default value: snmp version: optionType: default value: '1' securityLevel: optionType: default value: noAuthNoPriv notify: optionType: default value: snmpNotify read: optionType: default value: snmpRead write: optionType: default value: snmpWrite user: userName: optionType: global value: xxx version: optionType: default value: '1' userGroup: optionType: global value: xxx authProtocol: optionType: global value: xxx privProtocol: optionType: global value: xxx passphrase: optionType: global value: xxx host: hostName: optionType: global value: xxx ip: optionType: global value: xxx port: optionType: default value: 162 hostUserName: optionType: global value: xxx hostVersion: optionType: default value: '1' hostSecurityLevel: optionType: global value: xxx linkUp: optionType: default value: false linkDown: optionType: default value: false name: '[parcelType]ParcelGlobalDefault' $$ref: '#/components/examples/ProfileparcelNfvirtualSystemSnmpPutRequest_example_1' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > Snmp-write /v1/feature-profile/nfvirtual/system/{systemId}/system-settings: post: tags: - Configuration - Feature Profile (NFVirtual) description: Create System settings Profile Parcel for System feature profile operationId: CreateNfvirtualSystemSettingsParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string requestBody: description: System Settings config Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: nameServer: description: Name Server type: array maxItems: 3 uniqueItems: true items: type: object properties: name: description: Set hostname or IPv4 address of server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPostRequest_nameServerNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPostRequest_oneOfNameServerNameOptionsDef' required: - name additionalProperties: false dpdk: description: Enable/Disable Data Plane Development Kit 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 - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: boolean enum: - false $$ref: '#/components/schemas/CommonCommonDefs_booleanFalseDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPostRequest_oneOfDpdkOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPostRequest_SchemaPayload' examples: SystemSettingsParcelGlobalDefault: value: data: nameServer: name: optionType: global value: xxx dpdk: optionType: default value: false name: SystemSettingsParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualSystemSystemSettingsPostRequest_SystemSettingsParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > System Settings-write /v1/feature-profile/nfvirtual/system/{systemId}/system-settings/{systemSettingsId}: put: tags: - Configuration - Feature Profile (NFVirtual) description: Edit a System Settings Profile Parcel for System feature profile operationId: EditNfvirtualSystemSettingsParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: systemSettingsId in: path description: Profile Parcel ID required: true schema: 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}' type: string requestBody: description: System Settings Profile Parcel content: application/json: schema: type: object properties: name: type: string pattern: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: nameServer: description: Name Server type: array maxItems: 3 uniqueItems: true items: type: object properties: name: description: Set hostname or IPv4 address of server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPutRequest_nameServerNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPutRequest_oneOfNameServerNameOptionsDef' required: - name additionalProperties: false dpdk: description: Enable/Disable Data Plane Development Kit 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 - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: boolean enum: - false $$ref: '#/components/schemas/CommonCommonDefs_booleanFalseDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPutRequest_oneOfDpdkOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPutRequest_SchemaPayload' examples: SystemSettingsParcelGlobalDefault: value: data: nameServer: name: optionType: global value: xxx dpdk: optionType: default value: false name: SystemSettingsParcelGlobalDefault $$ref: '#/components/examples/ProfileparcelNfvirtualSystemSystemSettingsPutRequest_SystemSettingsParcelGlobalDefault' required: true responses: '200': description: Success content: application/json: schema: type: object properties: id: 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}' required: - id x-metadata: minVManageVersion: 20.15.1 additionalProperties: false $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload' examples: example_1: value: id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > System Settings-write delete: tags: - Configuration - Feature Profile (NFVirtual) description: Delete System settings Profile Parcel for System feature profile operationId: DeleteNfvirtualSystemSettingsParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: systemSettingsId in: path description: Profile Parcel ID required: true schema: 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}' type: string responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > System Settings-write get: tags: - Configuration - Feature Profile (NFVirtual) description: Get System Settings Profile Parcels for System feature profile operationId: GetNfvirtualSystemSettingsParcel parameters: - name: systemId in: path description: Feature Profile ID required: true schema: 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}' type: string - name: systemSettingsId in: path description: Profile Parcel ID required: true schema: 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}' 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: ^[^&<>! "]+$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef' description: type: string data: type: object properties: nameServer: description: Name Server type: array maxItems: 3 uniqueItems: true items: type: object properties: name: description: Set hostname or IPv4 address of server type: object oneOf: - properties: optionType: type: string enum: - global $$ref: '#/components/schemas/CommonCommonDefs_globalOptionTypeDef' value: type: string format: ipv4 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPutRequest_nameServerNameDef' required: - optionType - value additionalProperties: false - properties: optionType: type: string enum: - variable $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeDef' value: type: string pattern: ^\{\{[.\/\[\]a-zA-Z0-9_-]+\}\}$ minLength: 1 maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_valueDef' default: minLength: 1 type: string maxLength: 2048 $$ref: '#/components/schemas/CommonCommonDefs_defaultDef' description: minLength: 1 type: string maxLength: 128 $$ref: '#/components/schemas/CommonCommonDefs_descriptionDef' required: - optionType - value additionalProperties: false $$ref: '#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef' $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPutRequest_oneOfNameServerNameOptionsDef' required: - name additionalProperties: false dpdk: description: Enable/Disable Data Plane Development Kit 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 - properties: optionType: type: string enum: - default $$ref: '#/components/schemas/CommonCommonDefs_defaultOptionTypeDef' value: type: boolean enum: - false $$ref: '#/components/schemas/CommonCommonDefs_booleanFalseDef' required: - optionType additionalProperties: false $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPutRequest_oneOfDpdkOptionsDef' required: [] additionalProperties: false required: - data x-metadata: minVManageVersion: 20.15.1 $$ref: '#/components/schemas/ProfileparcelNfvirtualSystemSystemSettingsPutRequest_SchemaPayload' $$ref: '#/components/schemas/getSingleNfvirtualSystemSystemSettingsPayload' examples: get response example: value: parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902 parcelType: system-settings createdBy: admin lastUpdatedBy: admin createdOn: 1701866357838 lastUpdatedOn: 1701866357838 payload: data: nameServer: name: optionType: global value: xxx dpdk: optionType: default value: false $$ref: '#/components/examples/getSingleNfvirtualSystemSystemSettingsExample' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Feature Profile > Nfvirtual System > System Settings-read