{ "openapi": "3.1.0", "info": { "title": "Feature Profiles - Mobility and NFV", "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 (Mobility)" }, { "name": "Configuration - Feature Profile (NFVirtual)" } ], "paths": { "/v1/feature-profile/mobility/cli": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Mobility Cli Feature Profiles", "operationId": "GetMobilityCliFeatureProfile", "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 } }, { "name": "referenceCount", "in": "query", "description": "get associated group details", "schema": { "type": "boolean", "default": false } } ], "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": [ "mobility" ] } } }, "$$ref": "#/components/schemas/getListMobilityCliPayload" }, "examples": { "get response example": { "value": [ { "profileId": "bc99ae4f-0ac3-4a51-95cb-c718953143ce", "profileName": "cg1_LAN", "solution": "mobility", "profileType": "cli", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701850310222, "description": "cg1 cli Profile", "lastUpdatedOn": 1702292120081 } ], "$$ref": "#/components/examples/getListMobilityCliExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker CLI Add On-read" } }, "/v1/feature-profile/mobility/cli/{cliId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get a Mobility Feature Profile with Cli profile type", "operationId": "GetMobilityCliFeatureProfileByCliId", "parameters": [ { "name": "cliId", "in": "path", "description": "Feature Profile Id", "required": true, "schema": { "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": [ "mobility" ] }, "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/getSingleMobilityCliPayload" }, "examples": { "get response example": { "value": { "profileName": "cg1_LAN", "lastUpdatedBy": "admin", "description": "cg1 cli Profile", "profileParcelCount": 613, "createdOn": 1701850310222, "@rid": 3262, "profileType": "cli", "solution": "mobility", "createdBy": "admin", "profileId": "bc99ae4f-0ac3-4a51-95cb-c718953143ce", "lastUpdatedOn": 1702292120081, "associatedProfileParcels": [] }, "$$ref": "#/components/examples/getSingleMobilityCliExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker CLI Add On-read" } }, "/v1/feature-profile/mobility/cli/{cliId}/config": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get config Features for cli feature profile", "operationId": "GetAllConfigFeatureForMobility", "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": { "data": { "type": "array", "items": { "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": { "supportedDeviceTypes": [ "all" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityCliConfigPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListMobilityCliConfigPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "config", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "config": "gw-system:system logging disk enable\ngw-system:system admin-tech-on-failure" } } } ] }, "$$ref": "#/components/examples/getListMobilityCliConfigExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker CLI Add On > Config-read" }, "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create a config Feature for cli feature profile", "operationId": "CreateConfigFeatureForMobility", "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": "cli config Feature", "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": { "supportedDeviceTypes": [ "all" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityCliConfigPostRequest_SchemaPayload" }, "examples": { "CliConfigParcel1": { "value": { "data": { "config": "gw-system:system logging disk enable\ngw-system:system admin-tech-on-failure" }, "name": "CliConfigParcel1" }, "$$ref": "#/components/examples/ProfileparcelMobilityCliConfigPostRequest_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 > Teleworker CLI Add On > Config-write" } }, "/v1/feature-profile/mobility/cli/{cliId}/config/{configId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get config Feature by configId for cli feature profile", "operationId": "GetConfigFeatureForMobilityByParcelId", "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" } }, { "name": "configId", "in": "path", "description": "Feature 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": { "supportedDeviceTypes": [ "all" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityCliConfigPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleMobilityCliConfigPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "config", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "config": "gw-system:system logging disk enable\ngw-system:system admin-tech-on-failure" } } }, "$$ref": "#/components/examples/getSingleMobilityCliConfigExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker CLI Add On > Config-read" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Update a config Feature for cli feature profile", "operationId": "EditConfigFeatureForMobility", "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" } }, { "name": "configId", "in": "path", "description": "Feature 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 config Feature", "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": { "supportedDeviceTypes": [ "all" ], "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityCliConfigPutRequest_SchemaPayload" }, "examples": { "CliConfigParcel1": { "value": { "data": { "config": "gw-system:system logging disk enable\ngw-system:system admin-tech-on-failure" }, "name": "CliConfigParcel1" }, "$$ref": "#/components/examples/ProfileparcelMobilityCliConfigPutRequest_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 > Teleworker CLI Add On > Config-write" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a config Feature for cli feature profile", "operationId": "DeleteConfigFeatureForMobility", "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" } }, { "name": "configId", "in": "path", "description": "Feature 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 > Teleworker CLI Add On > Config-write" } }, "/v1/feature-profile/mobility/global": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Mobility Global Feature Profiles", "operationId": "GetMobilityGlobalFeatureProfile", "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 } }, { "name": "referenceCount", "in": "query", "description": "get associated group details", "schema": { "type": "boolean", "default": false } } ], "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": [ "global" ] }, "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": [ "mobility" ] } } }, "$$ref": "#/components/schemas/getListMobilityGlobalPayload" }, "examples": { "get response example": { "value": [ { "profileId": "bc99ae4f-0ac3-4a51-95cb-c718953143ce", "profileName": "cg1_LAN", "solution": "mobility", "profileType": "global", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701850310222, "description": "cg1 global Profile", "lastUpdatedOn": 1702292120081 } ], "$$ref": "#/components/examples/getListMobilityGlobalExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker-read" } }, "/v1/feature-profile/mobility/global/basic/schema": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get a Mobility Global Basic Parcel Schema by Schema Type", "operationId": "GetMobilityGlobalBasicParcelSchemaBySchemaType", "parameters": [ { "name": "schemaType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "post", "put" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "items": { "type": "object", "properties": { "name": { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "admin" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "password": { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "description": "Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters", "minLength": 8, "maxLength": 32, "allOf": [ { "pattern": ".*\\d{1,}.*" }, { "pattern": ".*[A-Z]{1,}.*" }, { "pattern": ".*[a-z]{1,}.*" }, { "pattern": ".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } }, "required": [ "name", "password" ], "additionalProperties": false } } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalBasicPostRequest_ResolvedSchema" }, "put": { "value": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128 }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "items": { "type": "object", "properties": { "name": { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "enum": [ "admin" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "password": { "properties": { "optionType": { "type": "string", "enum": [ "global" ] }, "value": { "type": "string", "description": "Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters", "minLength": 8, "maxLength": 32, "allOf": [ { "pattern": ".*\\d{1,}.*" }, { "pattern": ".*[A-Z]{1,}.*" }, { "pattern": ".*[a-z]{1,}.*" }, { "pattern": ".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*" } ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } }, "required": [ "name", "password" ], "additionalProperties": false } } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalBasicPutRequest_ResolvedSchema" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Basic-read" } }, "/v1/feature-profile/mobility/global/{globalId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get a Mobility Global Feature Profile by profileId", "operationId": "GetMobilityFeatureProfileByGlobalId", "parameters": [ { "name": "globalId", "in": "path", "description": "Feature Profile Id", "required": true, "schema": { "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": [ "global" ] }, "profileName": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef" }, "description": { "type": "string" }, "solution": { "type": "string", "enum": [ "mobility" ] }, "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/getSingleMobilityGlobalPayload" }, "examples": { "get response example": { "value": { "profileName": "cg1_LAN", "lastUpdatedBy": "admin", "description": "cg1 global Profile", "profileParcelCount": 613, "createdOn": 1701850310222, "@rid": 3262, "profileType": "global", "solution": "mobility", "createdBy": "admin", "profileId": "bc99ae4f-0ac3-4a51-95cb-c718953143ce", "lastUpdatedOn": 1702292120081, "associatedProfileParcels": [] }, "$$ref": "#/components/examples/getSingleMobilityGlobalExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker-read" } }, "/v1/feature-profile/mobility/global/{globalId}/qos": { "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create a Qos Feature for Global feature profile", "operationId": "CreateQosFeatureForGlobal", "parameters": [ { "name": "globalId", "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": "Qos Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "enableQos": { "type": "object", "description": "Enable the QOS feature", "oneOf": [ { "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": [ "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", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "gigabitEthernet00QosConfig": { "description": "GigabitEthernet0/0 IEEE 802.3z interface QOS configuration", "type": "object", "properties": { "rate": { "description": "Uplink Max data rate in Mbps 1 Teleworker > Qos-write" }, "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Qos Feature for Global feature profile", "operationId": "GetQosFeatureForGlobal", "parameters": [ { "name": "globalId", "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": { "data": { "type": "array", "items": { "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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "enableQos": { "type": "object", "description": "Enable the QOS feature", "oneOf": [ { "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": [ "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", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "gigabitEthernet00QosConfig": { "description": "GigabitEthernet0/0 IEEE 802.3z interface QOS configuration", "type": "object", "properties": { "rate": { "description": "Uplink Max data rate in Mbps 1 Teleworker > Qos-read" } }, "/v1/feature-profile/mobility/global/{globalId}/qos/{qosId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Qos Feature by parcelId for Global feature profile", "operationId": "GetQosFeatureByParcelIdForGlobal", "parameters": [ { "name": "globalId", "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": "qosId", "in": "path", "description": "Feature 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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "enableQos": { "type": "object", "description": "Enable the QOS feature", "oneOf": [ { "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": [ "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", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "gigabitEthernet00QosConfig": { "description": "GigabitEthernet0/0 IEEE 802.3z interface QOS configuration", "type": "object", "properties": { "rate": { "description": "Uplink Max data rate in Mbps 1 Teleworker > Qos-read" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a Qos Feature for Global feature profile", "operationId": "DeleteQosFeatureForGlobal", "parameters": [ { "name": "globalId", "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": "qosId", "in": "path", "description": "Feature 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 > Teleworker > Qos-write" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Update a Qos Feature for Global feature profile", "operationId": "EditQosFeatureForGlobal", "parameters": [ { "name": "globalId", "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": "qosId", "in": "path", "description": "Feature 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": "Qos Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "enableQos": { "type": "object", "description": "Enable the QOS feature", "oneOf": [ { "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": [ "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", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef" }, "gigabitEthernet00QosConfig": { "description": "GigabitEthernet0/0 IEEE 802.3z interface QOS configuration", "type": "object", "properties": { "rate": { "description": "Uplink Max data rate in Mbps 1 Teleworker > Qos-write" } }, "/v1/feature-profile/mobility/global/{profileId}/aaaservers": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get aaaservers Profile Parcels for Mobility Global Feature Profile", "operationId": "GetAaaServersProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "radiusServers": { "description": "Radius Server Configuration", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set the Radius Server Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 31, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_radiusServerNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_oneOfRadiusServerNameOptionsDef" }, "ipAddress": { "description": "Set the Radius Server IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$", "$$ref": "#/components/schemas/CommonCommonDefs_ipv4AddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_oneOfRadiusServerIpAddressOptionsDef" }, "port": { "description": "Set the Radius Server Port", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 65535, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_radiusServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_oneOfRadiusServerPortOptionsDef" }, "secret": { "description": "Set the Radius Server Secret", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_radiusServerSecretDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_oneOfRadiusServerSecretOptionsDef" } }, "required": [ "name", "ipAddress", "port", "secret" ], "additionalProperties": false } } }, "required": [ "radiusServers" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalAaaserversPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "aaaservers", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "radiusServers": [ { "name": { "optionType": "global", "value": "radiusServer7" }, "ipAddress": { "optionType": "global", "value": "10.5.6.2" }, "port": { "optionType": "global", "value": 5 }, "secret": { "optionType": "global", "value": "Secret$123" } } ] } } } ] }, "$$ref": "#/components/examples/getListMobilityGlobalAaaserversExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > AaaServers-read" }, "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create a aaaservers Profile Parcel for Mobility Global Feature Profile", "operationId": "CreateAaaServersProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "aaaservers Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "radiusServers": { "description": "Radius Server Configuration", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set the Radius Server Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 31, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_radiusServerNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_oneOfRadiusServerNameOptionsDef" }, "ipAddress": { "description": "Set the Radius Server IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$", "$$ref": "#/components/schemas/CommonCommonDefs_ipv4AddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_oneOfRadiusServerIpAddressOptionsDef" }, "port": { "description": "Set the Radius Server Port", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 65535, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_radiusServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_oneOfRadiusServerPortOptionsDef" }, "secret": { "description": "Set the Radius Server Secret", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_radiusServerSecretDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_oneOfRadiusServerSecretOptionsDef" } }, "required": [ "name", "ipAddress", "port", "secret" ], "additionalProperties": false } } }, "required": [ "radiusServers" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPostRequest_SchemaPayload" }, "examples": { "AonAAAServersParcelConfig": { "value": { "data": { "radiusServers": [ { "name": { "optionType": "global", "value": "radiusServer7" }, "ipAddress": { "optionType": "global", "value": "10.5.6.2" }, "port": { "optionType": "global", "value": 5 }, "secret": { "optionType": "global", "value": "Secret$123" } } ] }, "description": "Aon AAA Servers Parcel config", "name": "AonAAAServersParcelConfig" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalAaaserversPostRequest_AonAAAServersParcelConfig" } } } }, "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 > Teleworker > AaaServers-write" } }, "/v1/feature-profile/mobility/global/{profileId}/aaaservers/{aaaserversId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get aaaservers Profile Parcel by parcelId for Mobility Global Feature Profile", "operationId": "GetAaaServersProfileParcelByParcelIdForMobility", "parameters": [ { "name": "profileId", "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": "aaaserversId", "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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "radiusServers": { "description": "Radius Server Configuration", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set the Radius Server Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 31, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_radiusServerNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_oneOfRadiusServerNameOptionsDef" }, "ipAddress": { "description": "Set the Radius Server IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$", "$$ref": "#/components/schemas/CommonCommonDefs_ipv4AddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_oneOfRadiusServerIpAddressOptionsDef" }, "port": { "description": "Set the Radius Server Port", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 65535, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_radiusServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_oneOfRadiusServerPortOptionsDef" }, "secret": { "description": "Set the Radius Server Secret", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_radiusServerSecretDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_oneOfRadiusServerSecretOptionsDef" } }, "required": [ "name", "ipAddress", "port", "secret" ], "additionalProperties": false } } }, "required": [ "radiusServers" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleMobilityGlobalAaaserversPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "aaaservers", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "radiusServers": [ { "name": { "optionType": "global", "value": "radiusServer7" }, "ipAddress": { "optionType": "global", "value": "10.6.5.4" }, "port": { "optionType": "global", "value": 5 }, "secret": { "optionType": "global", "value": "Secret$123" } } ] } } }, "$$ref": "#/components/examples/getSingleMobilityGlobalAaaserversExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > AaaServers-read" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Update a aaaservers Profile Parcel for Mobility Global Feature Profile", "operationId": "EditAaaServersProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "aaaserversId", "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": "aaaservers Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "radiusServers": { "description": "Radius Server Configuration", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "Set the Radius Server Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "maxLength": 31, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_radiusServerNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_oneOfRadiusServerNameOptionsDef" }, "ipAddress": { "description": "Set the Radius Server IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$", "$$ref": "#/components/schemas/CommonCommonDefs_ipv4AddressDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_oneOfRadiusServerIpAddressOptionsDef" }, "port": { "description": "Set the Radius Server Port", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 65535, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_radiusServerPortDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_oneOfRadiusServerPortOptionsDef" }, "secret": { "description": "Set the Radius Server Secret", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_radiusServerSecretDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_oneOfRadiusServerSecretOptionsDef" } }, "required": [ "name", "ipAddress", "port", "secret" ], "additionalProperties": false } } }, "required": [ "radiusServers" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalAaaserversPutRequest_SchemaPayload" }, "examples": { "AonAAAServersParcelConfig": { "value": { "data": { "radiusServers": [ { "name": { "optionType": "global", "value": "radiusServer7" }, "ipAddress": { "optionType": "global", "value": "10.6.5.4" }, "port": { "optionType": "global", "value": 5 }, "secret": { "optionType": "global", "value": "Secret$123" } } ] }, "description": "Aon AAA Servers Parcel config", "name": "AonAAAServersParcelConfig" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalAaaserversPutRequest_AonAAAServersParcelConfig" } } } }, "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 > Teleworker > AaaServers-write" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a aaaservers Profile Parcel for Mobility Global Feature Profile", "operationId": "DeleteAaaServersProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "aaaserversId", "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 > Teleworker > AaaServers-write" } }, "/v1/feature-profile/mobility/global/{profileId}/basic": { "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create a Basic Profile Parcel for Mobility Global Feature Profile", "operationId": "CreateBasicProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "Basic Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "items": { "type": "object", "properties": { "name": { "description": "Set the username", "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "admin" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_oneOfUserNameOptionsDef" }, "password": { "description": "Set the user password", "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "pattern": ".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*", "type": "string", "description": "Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters", "minLength": 8, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_userPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_oneOfUserPasswordOptionsDef" } }, "required": [ "name", "password" ], "additionalProperties": false } } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_SchemaPayload" }, "examples": { "AonBasicParcelConfig": { "value": { "data": { "user": [ { "name": { "optionType": "global", "value": "admin" }, "password": { "optionType": "global", "value": "Admin@123" } } ] }, "description": "Aon Basic Parcel config", "name": "AonBasicParcelConfig" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalBasicPostRequest_AonBasicParcelConfig" } } } }, "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 > Teleworker > Basic-write" }, "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Basic Profile Parcels for Mobility Global Feature Profile", "operationId": "GetBasicProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "items": { "type": "object", "properties": { "name": { "description": "Set the username", "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "admin" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_oneOfUserNameOptionsDef" }, "password": { "description": "Set the user password", "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "pattern": ".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*", "type": "string", "description": "Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters", "minLength": 8, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_userPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_oneOfUserPasswordOptionsDef" } }, "required": [ "name", "password" ], "additionalProperties": false } } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalBasicPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "basic", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "user": [ { "name": { "optionType": "global", "value": "admin" }, "password": { "optionType": "global", "value": "Admin@123" } } ] } } } ] }, "$$ref": "#/components/examples/getListMobilityGlobalBasicExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Basic-read" } }, "/v1/feature-profile/mobility/global/{profileId}/basic/{parcelId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Basic Profile Parcel by parcelId for Mobility Global Feature Profile", "operationId": "GetBasicProfileParcelByParcelIdForMobility", "parameters": [ { "name": "profileId", "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": "parcelId", "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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "items": { "type": "object", "properties": { "name": { "description": "Set the username", "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "admin" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_oneOfUserNameOptionsDef" }, "password": { "description": "Set the user password", "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "pattern": ".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*", "type": "string", "description": "Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters", "minLength": 8, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_userPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_oneOfUserPasswordOptionsDef" } }, "required": [ "name", "password" ], "additionalProperties": false } } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleMobilityGlobalBasicPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "basic", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "user": [ { "name": { "optionType": "global", "value": "admin" }, "password": { "optionType": "global", "value": "Admin@123" } } ] } } }, "$$ref": "#/components/examples/getSingleMobilityGlobalBasicExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Basic-read" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Update a Basic Profile Parcel for Mobility Global Feature Profile", "operationId": "EditBasicProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "parcelId", "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": "Basic Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "user": { "description": "Create local login account", "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "items": { "type": "object", "properties": { "name": { "description": "Set the username", "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "admin" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_userNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_oneOfUserNameOptionsDef" }, "password": { "description": "Set the user password", "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "pattern": ".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*", "type": "string", "description": "Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters", "minLength": 8, "maxLength": 32, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_userPasswordDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_oneOfUserPasswordOptionsDef" } }, "required": [ "name", "password" ], "additionalProperties": false } } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalBasicPutRequest_SchemaPayload" }, "examples": { "AonBasicParcelConfig": { "value": { "data": { "user": [ { "name": { "optionType": "global", "value": "admin" }, "password": { "optionType": "global", "value": "Admin@123" } } ] }, "description": "Aon Basic Parcel config", "name": "AonBasicParcelConfig" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalBasicPutRequest_AonBasicParcelConfig" } } } }, "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 > Teleworker > Basic-write" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a Basic Profile Parcel for Mobility Global Feature Profile", "operationId": "DeleteBasicProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "parcelId", "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 > Teleworker > Basic-write" } }, "/v1/feature-profile/mobility/global/{profileId}/cellular": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get an Mobility Cellular Profile Parcel list for Mobility Global Feature Profile", "operationId": "GetCellularProfileParcelListForMobility", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": { "apn": { "type": "string" }, "authMethod": { "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", "type": "string" }, "id": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "password": { "type": "string" }, "pdnType": { "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", "type": "string" }, "userName": { "type": "string" } }, "$$ref": "#/components/schemas/CellularProfile" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalCellularPayload" }, "examples": { "Cellular Profile Parcel For Mobility Global Feature Profile": { "description": "Cellular Profile Parcel For Mobility Global Feature Profile", "value": { "header": { "generatedOn": 1628729307062 }, "data": [ { "parcelId": "8b698d5b-be6e-47bd-8567-1e5087b4b8d9", "parcelType": "cellular", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1628729253148, "lastUpdatedOn": 1628729253148, "payload": { "id": "1", "name": "ATTSingleSimPap", "variables": null, "simSlot0": { "carrierName": "AT&T", "slotNumber": 0, "profileList": [ { "id": 1, "apn": "att-apn1", "pdnType": "IPv4", "authMethod": "pap", "userName": "att1", "password": "admin1" }, { "id": 2, "apn": "att-apn11", "pdnType": "IPv6", "authMethod": "none", "userName": null, "password": null } ], "dataProfileIdList": [ 1 ], "attachProfile": 1 }, "simSlot1": { "carrierName": "AT&T", "slotNumber": 1, "profileList": [ { "id": 1, "apn": "att-apn2", "pdnType": "IPv4", "authMethod": "chap", "userName": "att2", "password": "admin2" }, { "id": 2, "apn": "att-apn22", "pdnType": "IPv6", "authMethod": "none", "userName": null, "password": null } ], "dataProfileIdList": [ 1 ], "attachProfile": 1 }, "primarySlot": 1, "wanConfig": null, "lastUpdatedBy": null, "lastUpdatedOn": null, "createdBy": null, "createdOn": null, "type": "cellular" } } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Cellular-read" }, "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create an cellular Profile Parcel for Mobility Global Feature Profile", "operationId": "CreateCellularProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "Cellular Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "apn": { "type": "string" }, "authMethod": { "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", "type": "string" }, "id": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "password": { "type": "string" }, "pdnType": { "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", "type": "string" }, "userName": { "type": "string" } }, "$$ref": "#/components/schemas/CellularProfile" }, "examples": { "Cellular Profile Parcel For Mobility Global Feature Profile": { "description": "Cellular Profile Parcel For Mobility Global Feature Profile", "value": { "type": "cellular", "simSlot0": { "carrierName": "AT&T", "slotNumber": 0, "profileList": [ { "id": 1, "apn": "att-apn1", "pdnType": "IPv4", "authMethod": "pap", "userName": "att1", "password": "admin1" }, { "id": 2, "apn": "att-apn11", "pdnType": "IPv6", "authMethod": "none" } ], "dataProfileIdList": [ 1 ], "attachProfileId": 1 }, "simSlot1": { "carrierName": "AT&T", "slotNumber": 1, "profileList": [ { "id": 1, "apn": "att-apn2", "pdnType": "IPv4", "authMethod": "chap", "userName": "att2", "password": "admin2" }, { "id": 2, "apn": "att-apn22", "pdnType": "IPv6", "authMethod": "none" } ], "dataProfileIdList": [ 1 ], "attachProfileId": 1 }, "primarySlot": 1, "id": "1", "name": "ATTSingleSimPap" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post response example": { "description": "post response example", "value": { "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Cellular-write" } }, "/v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get an Mobility Cellular Profile Parcel for Mobility Global Feature Profile", "operationId": "GetCellularProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "cellularId", "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": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "simSlot0": { "required": [ "attachProfileId", "profileList", "slotNumber" ], "type": "object", "properties": { "attachProfileId": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "carrierName": { "type": "string" }, "dataProfileIdList": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" } }, "profileList": { "maxItems": 16, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "apn": { "type": "string" }, "authMethod": { "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", "type": "string" }, "id": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "password": { "type": "string" }, "pdnType": { "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", "type": "string" }, "userName": { "type": "string" } }, "$$ref": "#/components/schemas/CellularProfile" } }, "slotNumber": { "maximum": 1, "minimum": 0, "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/SimSlotConfig" }, "simSlot1": { "required": [ "attachProfileId", "profileList", "slotNumber" ], "type": "object", "properties": { "attachProfileId": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "carrierName": { "type": "string" }, "dataProfileIdList": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" } }, "profileList": { "maxItems": 16, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "apn": { "type": "string" }, "authMethod": { "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", "type": "string" }, "id": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "password": { "type": "string" }, "pdnType": { "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", "type": "string" }, "userName": { "type": "string" } }, "$$ref": "#/components/schemas/CellularProfile" } }, "slotNumber": { "maximum": 1, "minimum": 0, "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/SimSlotConfig" }, "primarySlot": { "maximum": 1, "minimum": 0, "type": "integer", "format": "int32" }, "wanConfig": { "pattern": "(^Active$|^Standby$)", "type": "string" } }, "required": [ "name", "type", "name", "primarySlot", "type" ], "type": "object", "$$ref": "#/components/schemas/Cellular" } }, "$$ref": "#/components/schemas/getSingleMobilityGlobalCellularPayload" }, "examples": { "Cellular Profile Parcel For Mobility Global Feature Profile": { "description": "Cellular Profile Parcel For Mobility Global Feature Profile", "value": { "type": "cellular", "simSlot0": { "carrierName": "AT&T", "slotNumber": 0, "profileList": [ { "id": 1, "apn": "att-apn1", "pdnType": "IPv4", "authMethod": "pap", "userName": "att1", "password": "admin1" }, { "id": 2, "apn": "att-apn11", "pdnType": "IPv6", "authMethod": "none" } ], "dataProfileIdList": [ 1 ], "attachProfileId": 1 }, "simSlot1": { "carrierName": "AT&T", "slotNumber": 1, "profileList": [ { "id": 1, "apn": "att-apn2", "pdnType": "IPv4", "authMethod": "chap", "userName": "att2", "password": "admin2" }, { "id": 2, "apn": "att-apn22", "pdnType": "IPv6", "authMethod": "none" } ], "dataProfileIdList": [ 1 ], "attachProfileId": 1 }, "primarySlot": 1, "id": "1", "name": "ATTSingleSimPap" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Cellular-read" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Edit an Cellular Profile Parcel for Mobility Global Feature Profile", "operationId": "EditCellularProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "cellularId", "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": "Cellular Profile Parcel", "content": { "application/json": { "schema": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "simSlot0": { "required": [ "attachProfileId", "profileList", "slotNumber" ], "type": "object", "properties": { "attachProfileId": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "carrierName": { "type": "string" }, "dataProfileIdList": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" } }, "profileList": { "maxItems": 16, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "apn": { "type": "string" }, "authMethod": { "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", "type": "string" }, "id": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "password": { "type": "string" }, "pdnType": { "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", "type": "string" }, "userName": { "type": "string" } }, "$$ref": "#/components/schemas/CellularProfile" } }, "slotNumber": { "maximum": 1, "minimum": 0, "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/SimSlotConfig" }, "simSlot1": { "required": [ "attachProfileId", "profileList", "slotNumber" ], "type": "object", "properties": { "attachProfileId": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "carrierName": { "type": "string" }, "dataProfileIdList": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" } }, "profileList": { "maxItems": 16, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "apn": { "type": "string" }, "authMethod": { "pattern": "(^none$|^pap$|^chap$|^pap_or_chap$)", "type": "string" }, "id": { "maximum": 16, "minimum": 1, "type": "integer", "format": "int32" }, "password": { "type": "string" }, "pdnType": { "pattern": "(^IPv4$|^IPv6$|^IPv4v6$)", "type": "string" }, "userName": { "type": "string" } }, "$$ref": "#/components/schemas/CellularProfile" } }, "slotNumber": { "maximum": 1, "minimum": 0, "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/SimSlotConfig" }, "primarySlot": { "maximum": 1, "minimum": 0, "type": "integer", "format": "int32" }, "wanConfig": { "pattern": "(^Active$|^Standby$)", "type": "string" } }, "required": [ "name", "type", "name", "primarySlot", "type" ], "type": "object", "$$ref": "#/components/schemas/Cellular" }, "examples": { "Cellular Profile Parcel For Mobility Global Feature Profile": { "description": "Cellular Profile Parcel For Mobility Global Feature Profile", "value": { "type": "cellular", "simSlot0": { "carrierName": "AT&T", "slotNumber": 0, "profileList": [ { "id": 1, "apn": "att-apn1", "pdnType": "IPv4", "authMethod": "pap", "userName": "att1", "password": "admin1" }, { "id": 2, "apn": "att-apn11", "pdnType": "IPv6", "authMethod": "none" } ], "dataProfileIdList": [ 1 ], "attachProfileId": 1 }, "simSlot1": { "carrierName": "AT&T", "slotNumber": 1, "profileList": [ { "id": 1, "apn": "att-apn2", "pdnType": "IPv4", "authMethod": "chap", "userName": "att2", "password": "admin2" }, { "id": 2, "apn": "att-apn22", "pdnType": "IPv6", "authMethod": "none" } ], "dataProfileIdList": [ 1 ], "attachProfileId": 1 }, "primarySlot": 1, "id": "1", "name": "ATTSingleSimPap" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Cellular-write" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a Cellular Profile Parcel for Mobility Global Feature Profile", "operationId": "DeleteACellularProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "cellularId", "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 > Teleworker > Cellular-write" } }, "/v1/feature-profile/mobility/global/{profileId}/esimcellular": { "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create a EsimCellular Profile Feature for Mobility Global Feature Profile", "operationId": "CreateEsimCellularProfileFeatureForMobility", "parameters": [ { "name": "profileId", "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": "EsimCellular Profile Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the eSim Cellular profile feature name" }, "description": { "description": "Set the eSim Cellular profile feature description", "type": "string" }, "data": { "type": "object", "properties": { "wanConfig": { "description": "Set wanConfig for cellular as Active/Standby", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "Active", "Standby" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_wanConfigDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_wanConfigOptionTypesDef" }, "slotConfig": { "type": "object", "description": "Set the slot specific eSim cellular configuration", "properties": { "slot0Config": { "description": "Set the slot 0 eSim cellular configuration", "type": "object", "properties": { "accountInfo": { "type": "object", "properties": { "accountId": { "type": "object", "description": "Set provider account Id used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "commPlan": { "type": "object", "description": "Set communication plan used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "ratePlan": { "type": "object", "description": "Set rate plan used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } }, "required": [ "accountId", "commPlan", "ratePlan" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_eSimAccountInfoDef" }, "attachProfileConfig": { "description": "Set attach profile eSim cellular configuration", "type": "object", "properties": { "apn": { "description": "Set access point name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_apnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfApnOptionsDef" }, "authentication": { "oneOf": [ { "type": "object", "properties": { "noAuthentication": { "type": "object", "description": "No Authentication", "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "none" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfDefaultAuthenticationOptionsDef" } }, "required": [ "noAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNoAuthenticationOptionsDef" }, { "type": "object", "properties": { "needAuthentication": { "type": "object", "properties": { "type": { "description": "Set authentication type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "pap", "chap", "pap_chap" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_authenticationDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfAuthenticationOptionsDef" }, "username": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfUsernameOptionsDef" }, "password": { "description": "Set the password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_passwordDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPasswordOptionsDef" } }, "required": [ "type", "username", "password" ], "additionalProperties": false } }, "required": [ "needAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNeedAuthenticationOptionsDef" } ] }, "pdnType": { "description": "Set packet data network type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "IPv4", "enum": [ "IPv4", "IPv6", "IPv4v6" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_pdnTypeDef" } }, "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": [ "IPv4" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultPdnTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPdnTypeOptionsDef" } }, "required": [ "apn" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_commonCellularProfileInfoDef" }, "dataProfileConfig": { "description": "Set data profile eSim cellular configuration", "type": "object", "properties": { "apn": { "description": "Set access point name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_apnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfApnOptionsDef" }, "authentication": { "oneOf": [ { "type": "object", "properties": { "noAuthentication": { "type": "object", "description": "No Authentication", "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "none" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfDefaultAuthenticationOptionsDef" } }, "required": [ "noAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNoAuthenticationOptionsDef" }, { "type": "object", "properties": { "needAuthentication": { "type": "object", "properties": { "type": { "description": "Set authentication type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "pap", "chap", "pap_chap" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_authenticationDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfAuthenticationOptionsDef" }, "username": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfUsernameOptionsDef" }, "password": { "description": "Set the password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_passwordDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPasswordOptionsDef" } }, "required": [ "type", "username", "password" ], "additionalProperties": false } }, "required": [ "needAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNeedAuthenticationOptionsDef" } ] }, "pdnType": { "description": "Set packet data network type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "IPv4", "enum": [ "IPv4", "IPv6", "IPv4v6" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_pdnTypeDef" } }, "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": [ "IPv4" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultPdnTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPdnTypeOptionsDef" } }, "required": [ "apn" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_commonCellularProfileInfoDef" } }, "required": [ "accountInfo", "attachProfileConfig" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_eSimCellularSlotConfigDef" } }, "required": [ "slot0Config" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_slotConfigDef" } }, "required": [ "slotConfig" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_SchemaPayload" }, "examples": { "AON_CG1_eSim_Cellular_Profile_Feature1": { "value": { "data": { "slotConfig": { "slot0Config": { "accountInfo": { "accountId": { "optionType": "global", "value": "accountId1" }, "commPlan": { "optionType": "global", "value": "comPlan1" }, "ratePlan": { "optionType": "global", "value": "ratePlan1" } }, "attachProfileConfig": { "apn": { "optionType": "global", "value": "apn1" }, "authentication": { "noAuthentication": { "optionType": "default", "value": "none" } }, "pdnType": { "optionType": "default", "value": "IPv4" } } } } }, "description": "AON eSim Cellular Profile Feature config", "name": "AON_CG1_eSim_Cellular_Profile_Feature1" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalEsimcellularPostRequest_AON_CG1_eSim_Cellular_Profile_Feature1" } } } }, "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 > Teleworker > eSimCellular-write" }, "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get EsimCellular Profile Features for Mobility Global Feature Profile", "operationId": "GetEsimCellularProfileFeatureForMobility", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": "Set the eSim Cellular profile feature name" }, "description": { "description": "Set the eSim Cellular profile feature description", "type": "string" }, "data": { "type": "object", "properties": { "wanConfig": { "description": "Set wanConfig for cellular as Active/Standby", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "Active", "Standby" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_wanConfigDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_wanConfigOptionTypesDef" }, "slotConfig": { "type": "object", "description": "Set the slot specific eSim cellular configuration", "properties": { "slot0Config": { "description": "Set the slot 0 eSim cellular configuration", "type": "object", "properties": { "accountInfo": { "type": "object", "properties": { "accountId": { "type": "object", "description": "Set provider account Id used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "commPlan": { "type": "object", "description": "Set communication plan used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "ratePlan": { "type": "object", "description": "Set rate plan used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } }, "required": [ "accountId", "commPlan", "ratePlan" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_eSimAccountInfoDef" }, "attachProfileConfig": { "description": "Set attach profile eSim cellular configuration", "type": "object", "properties": { "apn": { "description": "Set access point name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_apnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfApnOptionsDef" }, "authentication": { "oneOf": [ { "type": "object", "properties": { "noAuthentication": { "type": "object", "description": "No Authentication", "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "none" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfDefaultAuthenticationOptionsDef" } }, "required": [ "noAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNoAuthenticationOptionsDef" }, { "type": "object", "properties": { "needAuthentication": { "type": "object", "properties": { "type": { "description": "Set authentication type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "pap", "chap", "pap_chap" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_authenticationDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfAuthenticationOptionsDef" }, "username": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfUsernameOptionsDef" }, "password": { "description": "Set the password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_passwordDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPasswordOptionsDef" } }, "required": [ "type", "username", "password" ], "additionalProperties": false } }, "required": [ "needAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNeedAuthenticationOptionsDef" } ] }, "pdnType": { "description": "Set packet data network type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "IPv4", "enum": [ "IPv4", "IPv6", "IPv4v6" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_pdnTypeDef" } }, "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": [ "IPv4" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultPdnTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPdnTypeOptionsDef" } }, "required": [ "apn" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_commonCellularProfileInfoDef" }, "dataProfileConfig": { "description": "Set data profile eSim cellular configuration", "type": "object", "properties": { "apn": { "description": "Set access point name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_apnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfApnOptionsDef" }, "authentication": { "oneOf": [ { "type": "object", "properties": { "noAuthentication": { "type": "object", "description": "No Authentication", "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "none" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfDefaultAuthenticationOptionsDef" } }, "required": [ "noAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNoAuthenticationOptionsDef" }, { "type": "object", "properties": { "needAuthentication": { "type": "object", "properties": { "type": { "description": "Set authentication type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "pap", "chap", "pap_chap" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_authenticationDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfAuthenticationOptionsDef" }, "username": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfUsernameOptionsDef" }, "password": { "description": "Set the password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_passwordDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPasswordOptionsDef" } }, "required": [ "type", "username", "password" ], "additionalProperties": false } }, "required": [ "needAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfNeedAuthenticationOptionsDef" } ] }, "pdnType": { "description": "Set packet data network type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "IPv4", "enum": [ "IPv4", "IPv6", "IPv4v6" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_pdnTypeDef" } }, "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": [ "IPv4" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_defaultPdnTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_oneOfPdnTypeOptionsDef" } }, "required": [ "apn" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_commonCellularProfileInfoDef" } }, "required": [ "accountInfo", "attachProfileConfig" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_eSimCellularSlotConfigDef" } }, "required": [ "slot0Config" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_slotConfigDef" } }, "required": [ "slotConfig" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalEsimcellularPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "esimcellular", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "slotConfig": { "slot0Config": { "accountInfo": { "accountId": { "optionType": "global", "value": "accountId1" }, "commPlan": { "optionType": "global", "value": "comPlan1" }, "ratePlan": { "optionType": "global", "value": "ratePlan1" } }, "attachProfileConfig": { "apn": { "optionType": "global", "value": "apn1" }, "authentication": { "noAuthentication": { "optionType": "default", "value": "none" } }, "pdnType": { "optionType": "default", "value": "IPv4" } } } } } } } ] }, "$$ref": "#/components/examples/getListMobilityGlobalEsimcellularExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > eSimCellular-read" } }, "/v1/feature-profile/mobility/global/{profileId}/esimcellular/{esimCellularId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get EsimCellular Profile Feature by Feature Id for Mobility Global Feature Profile", "operationId": "GetEsimCellularProfileFeatureByEsimCellularIdForMobility", "parameters": [ { "name": "profileId", "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": "esimCellularId", "in": "path", "description": "Feature 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": "Set the eSim Cellular profile feature name" }, "description": { "description": "Set the eSim Cellular profile feature description", "type": "string" }, "data": { "type": "object", "properties": { "wanConfig": { "description": "Set wanConfig for cellular as Active/Standby", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "Active", "Standby" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_wanConfigDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_wanConfigOptionTypesDef" }, "slotConfig": { "type": "object", "description": "Set the slot specific eSim cellular configuration", "properties": { "slot0Config": { "description": "Set the slot 0 eSim cellular configuration", "type": "object", "properties": { "accountInfo": { "type": "object", "properties": { "accountId": { "type": "object", "description": "Set provider account Id used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "commPlan": { "type": "object", "description": "Set communication plan used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "ratePlan": { "type": "object", "description": "Set rate plan used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } }, "required": [ "accountId", "commPlan", "ratePlan" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_eSimAccountInfoDef" }, "attachProfileConfig": { "description": "Set attach profile eSim cellular configuration", "type": "object", "properties": { "apn": { "description": "Set access point name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_apnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfApnOptionsDef" }, "authentication": { "oneOf": [ { "type": "object", "properties": { "noAuthentication": { "type": "object", "description": "No Authentication", "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "none" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_defaultAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfDefaultAuthenticationOptionsDef" } }, "required": [ "noAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfNoAuthenticationOptionsDef" }, { "type": "object", "properties": { "needAuthentication": { "type": "object", "properties": { "type": { "description": "Set authentication type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "pap", "chap", "pap_chap" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_authenticationDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfAuthenticationOptionsDef" }, "username": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfUsernameOptionsDef" }, "password": { "description": "Set the password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_passwordDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfPasswordOptionsDef" } }, "required": [ "type", "username", "password" ], "additionalProperties": false } }, "required": [ "needAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfNeedAuthenticationOptionsDef" } ] }, "pdnType": { "description": "Set packet data network type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "IPv4", "enum": [ "IPv4", "IPv6", "IPv4v6" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_pdnTypeDef" } }, "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": [ "IPv4" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_defaultPdnTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfPdnTypeOptionsDef" } }, "required": [ "apn" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_commonCellularProfileInfoDef" }, "dataProfileConfig": { "description": "Set data profile eSim cellular configuration", "type": "object", "properties": { "apn": { "description": "Set access point name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_apnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfApnOptionsDef" }, "authentication": { "oneOf": [ { "type": "object", "properties": { "noAuthentication": { "type": "object", "description": "No Authentication", "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "none" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_defaultAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfDefaultAuthenticationOptionsDef" } }, "required": [ "noAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfNoAuthenticationOptionsDef" }, { "type": "object", "properties": { "needAuthentication": { "type": "object", "properties": { "type": { "description": "Set authentication type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "pap", "chap", "pap_chap" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_authenticationDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfAuthenticationOptionsDef" }, "username": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfUsernameOptionsDef" }, "password": { "description": "Set the password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_passwordDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfPasswordOptionsDef" } }, "required": [ "type", "username", "password" ], "additionalProperties": false } }, "required": [ "needAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfNeedAuthenticationOptionsDef" } ] }, "pdnType": { "description": "Set packet data network type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "IPv4", "enum": [ "IPv4", "IPv6", "IPv4v6" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_pdnTypeDef" } }, "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": [ "IPv4" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_defaultPdnTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfPdnTypeOptionsDef" } }, "required": [ "apn" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_commonCellularProfileInfoDef" } }, "required": [ "accountInfo", "attachProfileConfig" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_eSimCellularSlotConfigDef" } }, "required": [ "slot0Config" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_slotConfigDef" } }, "required": [ "slotConfig" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleMobilityGlobalEsimcellularPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "esimcellular", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "slotConfig": { "slot0Config": { "accountInfo": { "accountId": { "optionType": "global", "value": "accountId1" }, "commPlan": { "optionType": "global", "value": "comPlan1" }, "ratePlan": { "optionType": "global", "value": "ratePlan1" } }, "attachProfileConfig": { "apn": { "optionType": "global", "value": "apn1" }, "authentication": { "noAuthentication": { "optionType": "default", "value": "none" } }, "pdnType": { "optionType": "default", "value": "IPv4" } } } } } } }, "$$ref": "#/components/examples/getSingleMobilityGlobalEsimcellularExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > eSimCellular-read" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Update a EsimCellular Profile Feature for Mobility Global Feature Profile", "operationId": "EditEsimCellularProfileFeatureForMobility", "parameters": [ { "name": "profileId", "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": "esimCellularId", "in": "path", "description": "Feature 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": "EsimCellular Profile Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the eSim Cellular profile feature name" }, "description": { "description": "Set the eSim Cellular profile feature description", "type": "string" }, "data": { "type": "object", "properties": { "wanConfig": { "description": "Set wanConfig for cellular as Active/Standby", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "Active", "Standby" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_wanConfigDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_wanConfigOptionTypesDef" }, "slotConfig": { "type": "object", "description": "Set the slot specific eSim cellular configuration", "properties": { "slot0Config": { "description": "Set the slot 0 eSim cellular configuration", "type": "object", "properties": { "accountInfo": { "type": "object", "properties": { "accountId": { "type": "object", "description": "Set provider account Id used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "commPlan": { "type": "object", "description": "Set communication plan used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false }, "ratePlan": { "type": "object", "description": "Set rate plan used for this configuration", "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "optionType", "value" ], "additionalProperties": false } }, "required": [ "accountId", "commPlan", "ratePlan" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_eSimAccountInfoDef" }, "attachProfileConfig": { "description": "Set attach profile eSim cellular configuration", "type": "object", "properties": { "apn": { "description": "Set access point name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_apnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfApnOptionsDef" }, "authentication": { "oneOf": [ { "type": "object", "properties": { "noAuthentication": { "type": "object", "description": "No Authentication", "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "none" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_defaultAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfDefaultAuthenticationOptionsDef" } }, "required": [ "noAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfNoAuthenticationOptionsDef" }, { "type": "object", "properties": { "needAuthentication": { "type": "object", "properties": { "type": { "description": "Set authentication type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "pap", "chap", "pap_chap" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_authenticationDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfAuthenticationOptionsDef" }, "username": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfUsernameOptionsDef" }, "password": { "description": "Set the password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_passwordDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfPasswordOptionsDef" } }, "required": [ "type", "username", "password" ], "additionalProperties": false } }, "required": [ "needAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfNeedAuthenticationOptionsDef" } ] }, "pdnType": { "description": "Set packet data network type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "IPv4", "enum": [ "IPv4", "IPv6", "IPv4v6" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_pdnTypeDef" } }, "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": [ "IPv4" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_defaultPdnTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfPdnTypeOptionsDef" } }, "required": [ "apn" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_commonCellularProfileInfoDef" }, "dataProfileConfig": { "description": "Set data profile eSim cellular configuration", "type": "object", "properties": { "apn": { "description": "Set access point name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_apnDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfApnOptionsDef" }, "authentication": { "oneOf": [ { "type": "object", "properties": { "noAuthentication": { "type": "object", "description": "No Authentication", "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "none" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_defaultAuthenticationDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfDefaultAuthenticationOptionsDef" } }, "required": [ "noAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfNoAuthenticationOptionsDef" }, { "type": "object", "properties": { "needAuthentication": { "type": "object", "properties": { "type": { "description": "Set authentication type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "pap", "chap", "pap_chap" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_authenticationDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfAuthenticationOptionsDef" }, "username": { "description": "Set the username", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfUsernameOptionsDef" }, "password": { "description": "Set the password", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_passwordDef" } }, "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/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfPasswordOptionsDef" } }, "required": [ "type", "username", "password" ], "additionalProperties": false } }, "required": [ "needAuthentication" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfNeedAuthenticationOptionsDef" } ] }, "pdnType": { "description": "Set packet data network type", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "default": "IPv4", "enum": [ "IPv4", "IPv6", "IPv4v6" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_pdnTypeDef" } }, "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": [ "IPv4" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_defaultPdnTypeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_oneOfPdnTypeOptionsDef" } }, "required": [ "apn" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_commonCellularProfileInfoDef" } }, "required": [ "accountInfo", "attachProfileConfig" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_eSimCellularSlotConfigDef" } }, "required": [ "slot0Config" ], "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_slotConfigDef" } }, "required": [ "slotConfig" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalEsimcellularPutRequest_SchemaPayload" }, "examples": { "AON_CG1_eSim_Cellular_Profile_Feature1": { "value": { "data": { "slotConfig": { "slot0Config": { "accountInfo": { "accountId": { "optionType": "global", "value": "accountId1" }, "commPlan": { "optionType": "global", "value": "comPlan1" }, "ratePlan": { "optionType": "global", "value": "ratePlan1" } }, "attachProfileConfig": { "apn": { "optionType": "global", "value": "apn1" }, "authentication": { "noAuthentication": { "optionType": "default", "value": "none" } }, "pdnType": { "optionType": "default", "value": "IPv4" } } } } }, "description": "AON eSim Cellular Profile Feature config", "name": "AON_CG1_eSim_Cellular_Profile_Feature1" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalEsimcellularPutRequest_AON_CG1_eSim_Cellular_Profile_Feature1" } } } }, "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 > Teleworker > eSimCellular-write" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a EsimCellular Profile Feature for Mobility Global Feature Profile", "operationId": "DeleteEsimCellularProfileFeatureForMobility", "parameters": [ { "name": "profileId", "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": "esimCellularId", "in": "path", "description": "Feature 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 > Teleworker > eSimCellular-write" } }, "/v1/feature-profile/mobility/global/{profileId}/ethernet": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Ethernet Profile Parcels for feature profile", "operationId": "GetEthernetProfileParcels", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "ethernetInterfaceList": { "type": "array", "items": { "required": [ "interfaceName", "portType" ], "type": "object", "properties": { "aaaServerInfo": { "required": [ "aaaServersParcelId", "radiusServerName" ], "type": "object", "properties": { "aaaServersParcelId": { "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" }, "radiusServerName": { "type": "string" } }, "$$ref": "#/components/schemas/AaaServerInfo" }, "adminState": { "pattern": "(enabled|disabled)", "type": "string" }, "corporateLan": { "type": "boolean" }, "interfaceName": { "pattern": "(^GigabitEthernet0/0$|^GigabitEthernet0/1$|^GigabitEthernet0/2$)", "type": "string" }, "ipAssignment": { "pattern": "(dynamic|static)", "type": "string" }, "ipv6Assignment": { "pattern": "(AutoConfig-SLAC)", "type": "string" }, "portType": { "pattern": "(LAN|WAN)", "type": "string" }, "staticIpAddress": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "staticIpAddressSubnetMask": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "staticRouteIp": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "wanConfiguration": { "pattern": "(Active)", "type": "string" } }, "$$ref": "#/components/schemas/EthernetInterface" } } }, "required": [ "name", "type", "ethernetInterfaceList", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/Ethernet" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalEthernetPayload" }, "examples": { "Ethernet Profile Parcel For Mobility Global Feature Profile": { "description": "Ethernet Profile Parcel For Mobility Global Feature Profile", "value": { "name": "config_grp_test", "description": "config_grp_test", "family": "aon", "featureprofiles": [ { "profileName": "config_grp_test_aon", "description": "", "profileType": "aon", "parcels": [ { "ethernetInterfaceList": [ { "interfaceName": "GigabitEthernet0/0", "portType": "WAN", "wanConfiguration": "Active", "ipAssignment": "static", "staticIpAddress": "1.1.1.2", "staticIpAddressSubnetMask": "255.255.0.0", "staticRouteIp": "5.5.5.5" }, { "interfaceName": "GigabitEthernet0/1", "portType": "LAN", "adminState": "enabled", "corporateLan": true }, { "interfaceName": "GigabitEthernet0/2", "portType": "LAN", "adminState": "disabled" } ], "parcelType": "ethernet", "subparcels": [] } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Ethernet-read" }, "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create an ethernet Profile Parcel for Mobility Global Feature Profile", "operationId": "CreateEthernetProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "Ethernet Profile Parcel", "content": { "application/json": { "schema": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "ethernetInterfaceList": { "type": "array", "items": { "required": [ "interfaceName", "portType" ], "type": "object", "properties": { "aaaServerInfo": { "required": [ "aaaServersParcelId", "radiusServerName" ], "type": "object", "properties": { "aaaServersParcelId": { "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" }, "radiusServerName": { "type": "string" } }, "$$ref": "#/components/schemas/AaaServerInfo" }, "adminState": { "pattern": "(enabled|disabled)", "type": "string" }, "corporateLan": { "type": "boolean" }, "interfaceName": { "pattern": "(^GigabitEthernet0/0$|^GigabitEthernet0/1$|^GigabitEthernet0/2$)", "type": "string" }, "ipAssignment": { "pattern": "(dynamic|static)", "type": "string" }, "ipv6Assignment": { "pattern": "(AutoConfig-SLAC)", "type": "string" }, "portType": { "pattern": "(LAN|WAN)", "type": "string" }, "staticIpAddress": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "staticIpAddressSubnetMask": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "staticRouteIp": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "wanConfiguration": { "pattern": "(Active)", "type": "string" } }, "$$ref": "#/components/schemas/EthernetInterface" } } }, "required": [ "name", "type", "ethernetInterfaceList", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/Ethernet" }, "examples": { "Ethernet Profile Parcel For Aon Feature Profile": { "description": "Ethernet Profile Parcel For Aon Feature Profile", "value": { "name": "config_grp_test", "description": "config_grp_test", "family": "aon", "featureprofiles": [ { "profileName": "config_grp_test_aon", "description": "", "profileType": "aon", "parcels": [ { "ethernetInterfaceList": [ { "interfaceName": "GigabitEthernet0/0", "portType": "WAN", "wanConfiguration": "Active", "ipAssignment": "static", "staticIpAddress": "1.1.1.2", "staticIpAddressSubnetMask": "255.255.0.0", "staticRouteIp": "5.5.5.5" }, { "interfaceName": "GigabitEthernet0/1", "portType": "LAN", "adminState": "enabled", "corporateLan": true }, { "interfaceName": "GigabitEthernet0/2", "portType": "LAN", "adminState": "disabled" } ], "parcelType": "ethernet", "subparcels": [] } ] } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post response example": { "description": "post response example", "value": { "ethernetId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Ethernet-write" } }, "/v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Ethernet Profile Parcels for feature profile", "operationId": "GetEthernetProfileParcel", "parameters": [ { "name": "profileId", "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": "ethernetId", "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": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "ethernetInterfaceList": { "type": "array", "items": { "required": [ "interfaceName", "portType" ], "type": "object", "properties": { "aaaServerInfo": { "required": [ "aaaServersParcelId", "radiusServerName" ], "type": "object", "properties": { "aaaServersParcelId": { "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" }, "radiusServerName": { "type": "string" } }, "$$ref": "#/components/schemas/AaaServerInfo" }, "adminState": { "pattern": "(enabled|disabled)", "type": "string" }, "corporateLan": { "type": "boolean" }, "interfaceName": { "pattern": "(^GigabitEthernet0/0$|^GigabitEthernet0/1$|^GigabitEthernet0/2$)", "type": "string" }, "ipAssignment": { "pattern": "(dynamic|static)", "type": "string" }, "ipv6Assignment": { "pattern": "(AutoConfig-SLAC)", "type": "string" }, "portType": { "pattern": "(LAN|WAN)", "type": "string" }, "staticIpAddress": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "staticIpAddressSubnetMask": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "staticRouteIp": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "wanConfiguration": { "pattern": "(Active)", "type": "string" } }, "$$ref": "#/components/schemas/EthernetInterface" } } }, "required": [ "name", "type", "ethernetInterfaceList", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/Ethernet" }, "examples": { "Ethernet Profile Parcel For Mobility Global Feature Profile": { "description": "Ethernet Profile Parcel For Mobility Global Feature Profile", "value": { "name": "config_grp_test", "description": "config_grp_test", "family": "aon", "featureprofiles": [ { "profileName": "config_grp_test_aon", "description": "", "profileType": "aon", "parcels": [ { "ethernetInterfaceList": [ { "interfaceName": "GigabitEthernet0/0", "portType": "WAN", "wanConfiguration": "Active", "ipAssignment": "static", "staticIpAddress": "1.1.1.2", "staticIpAddressSubnetMask": "255.255.0.0", "staticRouteIp": "5.5.5.5" }, { "interfaceName": "GigabitEthernet0/1", "portType": "LAN", "adminState": "enabled", "corporateLan": true }, { "interfaceName": "GigabitEthernet0/2", "portType": "LAN", "adminState": "disabled" } ], "parcelType": "ethernet", "subparcels": [] } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Ethernet-read" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Update a Ethernet Profile Parcel for feature profile", "operationId": "EditEthernetProfileParcelForSystem", "parameters": [ { "name": "profileId", "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": "ethernetId", "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": "Ethernet Profile Parcel", "content": { "application/json": { "schema": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "ethernetInterfaceList": { "type": "array", "items": { "required": [ "interfaceName", "portType" ], "type": "object", "properties": { "aaaServerInfo": { "required": [ "aaaServersParcelId", "radiusServerName" ], "type": "object", "properties": { "aaaServersParcelId": { "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" }, "radiusServerName": { "type": "string" } }, "$$ref": "#/components/schemas/AaaServerInfo" }, "adminState": { "pattern": "(enabled|disabled)", "type": "string" }, "corporateLan": { "type": "boolean" }, "interfaceName": { "pattern": "(^GigabitEthernet0/0$|^GigabitEthernet0/1$|^GigabitEthernet0/2$)", "type": "string" }, "ipAssignment": { "pattern": "(dynamic|static)", "type": "string" }, "ipv6Assignment": { "pattern": "(AutoConfig-SLAC)", "type": "string" }, "portType": { "pattern": "(LAN|WAN)", "type": "string" }, "staticIpAddress": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "staticIpAddressSubnetMask": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "staticRouteIp": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "wanConfiguration": { "pattern": "(Active)", "type": "string" } }, "$$ref": "#/components/schemas/EthernetInterface" } } }, "required": [ "name", "type", "ethernetInterfaceList", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/Ethernet" }, "examples": { "Ethernet Profile Parcel For Mobility Global Feature Profile": { "description": "Ethernet Profile Parcel For Mobility Global Feature Profile", "value": { "type": "ethernet", "ethernetInterfaceList": [ { "interfaceName": "GigabitEthernet0/0", "wanConfiguration": "Active", "portType": "WAN", "ipAssignment": "static", "staticIpAddress": "1.1.1.2", "staticIpAddressSubnetMask": "255.255.0.0", "staticRouteIp": "3.3.3.3" }, { "interfaceName": "GigabitEthernet0/1", "adminState": "enabled" }, { "interfaceName": "GigabitEthernet0/2", "adminState": "disabled" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Ethernet-write" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a Ethernet Profile Parcel for feature profile", "operationId": "DeleteEthernetProfileParcelForSystem", "parameters": [ { "name": "profileId", "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": "ethernetId", "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 > Teleworker > Ethernet-write" } }, "/v1/feature-profile/mobility/global/{profileId}/logging": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Logging Profile Features for Mobility Global Feature Profile", "operationId": "GetLoggingProfileFeatureForMobility", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "description": "Enable logging to disk", "type": "object", "properties": { "file": { "description": "File to which to log messages", "type": "object", "properties": { "diskFileSize": { "description": "Maximum size of file before it is rotated, in MB", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_diskFileSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfDiskFileSizeOptionsDef" }, "diskFileRotate": { "description": "Number of rotations before the file is discarded", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_diskFileRotateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfDiskFileRotateOptionsDef" } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "server": { "description": "Remote host logging parameters", "type": "array", "uniqueItems": true, "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": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfServerNameOptionsDef" }, "sourceIp": { "description": "Source interface for outgoing logging messages to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "systemIp" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "enum": [ "{{logging_server_source_ip}}" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfsourceIpOptionsDef" }, "priority": { "description": "Set level of logging to file, default is ERROR", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "information", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "information", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "error" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfPriorityOptionsDef" } }, "required": [ "name", "sourceIp", "priority" ], "additionalProperties": false } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalLoggingPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "logging", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "disk": { "file": { "diskFileSize": { "optionType": "global", "value": 4 }, "diskFileRotate": { "optionType": "global", "value": 10 } } }, "server": [ { "name": { "optionType": "global", "value": "vm12" }, "sourceIp": { "optionType": "variable", "value": "{{logging_server_source_ip}}" }, "priority": { "optionType": "global", "value": "critical" } } ] } } } ] }, "$$ref": "#/components/examples/getListMobilityGlobalLoggingExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Logging-read" }, "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create a Logging Profile Feature for Mobility Global Feature Profile", "operationId": "CreateLoggingProfileFeatureForMobility", "parameters": [ { "name": "profileId", "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 Profile Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "description": "Enable logging to disk", "type": "object", "properties": { "file": { "description": "File to which to log messages", "type": "object", "properties": { "diskFileSize": { "description": "Maximum size of file before it is rotated, in MB", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_diskFileSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfDiskFileSizeOptionsDef" }, "diskFileRotate": { "description": "Number of rotations before the file is discarded", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_diskFileRotateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfDiskFileRotateOptionsDef" } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "server": { "description": "Remote host logging parameters", "type": "array", "uniqueItems": true, "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": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfServerNameOptionsDef" }, "sourceIp": { "description": "Source interface for outgoing logging messages to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "systemIp" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "enum": [ "{{logging_server_source_ip}}" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfsourceIpOptionsDef" }, "priority": { "description": "Set level of logging to file, default is ERROR", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "information", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "information", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "error" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_oneOfPriorityOptionsDef" } }, "required": [ "name", "sourceIp", "priority" ], "additionalProperties": false } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPostRequest_SchemaPayload" }, "examples": { "AON_CG1_MOBILITY_Logging_parcel1": { "value": { "data": { "disk": { "file": { "diskFileSize": { "optionType": "global", "value": 4 }, "diskFileRotate": { "optionType": "global", "value": 10 } } }, "server": [ { "name": { "optionType": "global", "value": "vm12" }, "sourceIp": { "optionType": "variable", "value": "{{logging_server_source_ip}}" }, "priority": { "optionType": "global", "value": "critical" } } ] }, "description": "AON System Logging Parcel config", "name": "AON_CG1_MOBILITY_Logging_parcel1" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalLoggingPostRequest_AON_CG1_MOBILITY_Logging_parcel1" } } } }, "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 > Teleworker > Logging-write" } }, "/v1/feature-profile/mobility/global/{profileId}/logging/{loggingId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Logging Profile Feature by parcelId for Mobility Global Feature Profile", "operationId": "GetLoggingProfileFeatureByFeatureIdForMobility", "parameters": [ { "name": "profileId", "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 Feature 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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "description": "Enable logging to disk", "type": "object", "properties": { "file": { "description": "File to which to log messages", "type": "object", "properties": { "diskFileSize": { "description": "Maximum size of file before it is rotated, in MB", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_diskFileSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfDiskFileSizeOptionsDef" }, "diskFileRotate": { "description": "Number of rotations before the file is discarded", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_diskFileRotateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfDiskFileRotateOptionsDef" } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "server": { "description": "Remote host logging parameters", "type": "array", "uniqueItems": true, "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": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfServerNameOptionsDef" }, "sourceIp": { "description": "Source interface for outgoing logging messages to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "systemIp" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "enum": [ "{{logging_server_source_ip}}" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfsourceIpOptionsDef" }, "priority": { "description": "Set level of logging to file, default is ERROR", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "information", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "information", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "error" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfPriorityOptionsDef" } }, "required": [ "name", "sourceIp", "priority" ], "additionalProperties": false } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleMobilityGlobalLoggingPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "logging", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "disk": { "file": { "diskFileSize": { "optionType": "global", "value": 4 }, "diskFileRotate": { "optionType": "global", "value": 10 } } }, "server": [ { "name": { "optionType": "global", "value": "vm12" }, "sourceIp": { "optionType": "variable", "value": "{{logging_server_source_ip}}" }, "priority": { "optionType": "global", "value": "critical" } } ] } } }, "$$ref": "#/components/examples/getSingleMobilityGlobalLoggingExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Logging-read" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a Logging Profile Feature for Mobility Global Feature Profile", "operationId": "DeleteLoggingProfileFeatureForMobility", "parameters": [ { "name": "profileId", "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 Feature 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 > Teleworker > Logging-write" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Update a Logging Profile Feature for Mobility Global Feature Profile", "operationId": "EditLoggingProfileFeatureForMobility", "parameters": [ { "name": "profileId", "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 Feature 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 Feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "disk": { "description": "Enable logging to disk", "type": "object", "properties": { "file": { "description": "File to which to log messages", "type": "object", "properties": { "diskFileSize": { "description": "Maximum size of file before it is rotated, in MB", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_diskFileSizeDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfDiskFileSizeOptionsDef" }, "diskFileRotate": { "description": "Number of rotations before the file is discarded", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "integer", "minimum": 1, "maximum": 10, "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_diskFileRotateDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "default": 10 } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfDiskFileRotateOptionsDef" } }, "required": [ "diskFileSize", "diskFileRotate" ], "additionalProperties": false } }, "required": [ "file" ], "additionalProperties": false }, "server": { "description": "Remote host logging parameters", "type": "array", "uniqueItems": true, "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": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfServerNameOptionsDef" }, "sourceIp": { "description": "Source interface for outgoing logging messages to server", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "systemIp" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "variable" ], "$$ref": "#/components/schemas/CommonCommonDefs_variableOptionTypeDef" }, "value": { "type": "string", "enum": [ "{{logging_server_source_ip}}" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfsourceIpOptionsDef" }, "priority": { "description": "Set level of logging to file, default is ERROR", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "enum": [ "information", "notice", "warn", "error", "critical", "alert", "emergency" ], "default": "information", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_prioritytDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "type": "string", "enum": [ "error" ] } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_oneOfPriorityOptionsDef" } }, "required": [ "name", "sourceIp", "priority" ], "additionalProperties": false } } }, "required": [ "disk" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalLoggingPutRequest_SchemaPayload" }, "examples": { "AON_CG1_MOBILITY_Logging_parcel1": { "value": { "data": { "disk": { "file": { "diskFileSize": { "optionType": "global", "value": 4 }, "diskFileRotate": { "optionType": "global", "value": 10 } } }, "server": [ { "name": { "optionType": "global", "value": "vm12" }, "sourceIp": { "optionType": "variable", "value": "{{logging_server_source_ip}}" }, "priority": { "optionType": "global", "value": "critical" } } ] }, "description": "AON System Logging Parcel config", "name": "AON_CG1_MOBILITY_Logging_parcel1" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalLoggingPutRequest_AON_CG1_MOBILITY_Logging_parcel1" } } } }, "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 > Teleworker > Logging-write" } }, "/v1/feature-profile/mobility/global/{profileId}/networkProtocol": { "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create an NetworkProtocol Profile Parcel for Mobility Global Feature Profile", "operationId": "CreateNetworkProtocolProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "NetworkProtocol Profile Parcel", "content": { "application/json": { "schema": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "DHCPPool": { "required": [ "leaseTimeDay", "leaseTimeHour", "leaseTimeMin", "poolNetwork" ], "type": "object", "properties": { "leaseTimeDay": { "maximum": 365, "minimum": 0, "type": "integer", "format": "int32" }, "leaseTimeHour": { "maximum": 23, "minimum": 0, "type": "integer", "format": "int32" }, "leaseTimeMin": { "maximum": 59, "minimum": 0, "type": "integer", "format": "int32" }, "poolNetwork": { "type": "string" } }, "$$ref": "#/components/schemas/DHCPPool" }, "DNSSettings": { "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])(%[\\p{N}\\p{L}]+)?)((\\s)(([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])(%[\\p{N}\\p{L}]+)?)?$", "type": "string" }, "NTPSettings": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "string" } }, "NATRules": { "type": "array", "items": { "required": [ "description", "inPort", "insideIp", "interface", "outPort", "protocol" ], "type": "object", "properties": { "description": { "type": "string" }, "inPort": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "insideIp": { "type": "string" }, "interface": { "type": "string" }, "outPort": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "protocol": { "pattern": "^udp$|^tcp$|^icmp$", "type": "string" } }, "$$ref": "#/components/schemas/NATRule" } }, "NTPInherit": { "type": "boolean" } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/NetworkProtocol" }, "examples": { "NetworkProtocol Profile Parcel For Mobility Global Feature Profile": { "description": "NetworkProtocol Profile Parcel For Mobility Global Feature Profile", "value": { "type": "networkProtocol", "DNSSettings": "1.1.1.1", "NTPInherit": false, "NTPSettings": [ "1.1.1.1", "1.1.1.2" ], "DHCPPool": { "poolNetwork": "192.168.0.0/24", "leaseTime": "2", "startAddress": "1.1.1.2", "endAddress": "1.1.1.3" }, "DHCPOptions": [ { "type": 2, "dataType": "integer", "dhcpValue": "2" } ], "NATRules": [ { "protocol": "udp", "outPort": 23, "inPort": 2, "insideIp": "1.1.1.1", "description": "test" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post response example": { "description": "post response example", "value": { "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-write" }, "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get an Mobility NetworkProtocol Profile Parcel list for Mobility Global Feature Profile", "operationId": "GetNetworkProtocolProfileParcelListForMobility", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "DHCPPool": { "required": [ "leaseTimeDay", "leaseTimeHour", "leaseTimeMin", "poolNetwork" ], "type": "object", "properties": { "leaseTimeDay": { "maximum": 365, "minimum": 0, "type": "integer", "format": "int32" }, "leaseTimeHour": { "maximum": 23, "minimum": 0, "type": "integer", "format": "int32" }, "leaseTimeMin": { "maximum": 59, "minimum": 0, "type": "integer", "format": "int32" }, "poolNetwork": { "type": "string" } }, "$$ref": "#/components/schemas/DHCPPool" }, "DNSSettings": { "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])(%[\\p{N}\\p{L}]+)?)((\\s)(([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])(%[\\p{N}\\p{L}]+)?)?$", "type": "string" }, "NTPSettings": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "string" } }, "NATRules": { "type": "array", "items": { "required": [ "description", "inPort", "insideIp", "interface", "outPort", "protocol" ], "type": "object", "properties": { "description": { "type": "string" }, "inPort": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "insideIp": { "type": "string" }, "interface": { "type": "string" }, "outPort": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "protocol": { "pattern": "^udp$|^tcp$|^icmp$", "type": "string" } }, "$$ref": "#/components/schemas/NATRule" } }, "NTPInherit": { "type": "boolean" } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/NetworkProtocol" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalNetworkprotocolPayload" }, "examples": { "NetworkProtocol Profile Parcel For Mobility Global Feature Profile": { "description": "NetworkProtocol Profile Parcel For Mobility Global Feature Profile", "value": { "header": { "generatedOn": 1628729936548 }, "data": [ { "parcelId": "4e958a77-03dc-4558-a45b-eeba554bb873", "parcelType": "networkProtocol", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1628729896431, "lastUpdatedOn": 1628729896431, "payload": { "id": null, "name": null, "variables": null, "DHCPPool": { "poolNetwork": "192.168.0.0/24", "leaseTime": 2, "startAddress": "1.1.1.2", "endAddress": "1.1.1.3" }, "DNSSettings": "1.1.1.1", "NTPInherit": false, "NTPSettings": [ "1.1.1.1", "1.1.1.2" ], "DHCPOptions": [ { "type": 2, "dhcpValue": "2", "dataType": "integer" } ], "NATRules": [ { "protocol": "udp", "outPort": 23, "inPort": 2, "insideIp": "1.1.1.1", "description": "test", "interface": "Cellular1/0" } ], "lastUpdatedBy": null, "lastUpdatedOn": null, "createdBy": null, "createdOn": null, "type": "networkProtocol" } } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-read" } }, "/v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get an Mobility NetworkProtocol Profile Parcel for Mobility Global Feature Profile", "operationId": "GetNetworkProtocolProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "networkProtocolId", "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": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "DHCPPool": { "required": [ "leaseTimeDay", "leaseTimeHour", "leaseTimeMin", "poolNetwork" ], "type": "object", "properties": { "leaseTimeDay": { "maximum": 365, "minimum": 0, "type": "integer", "format": "int32" }, "leaseTimeHour": { "maximum": 23, "minimum": 0, "type": "integer", "format": "int32" }, "leaseTimeMin": { "maximum": 59, "minimum": 0, "type": "integer", "format": "int32" }, "poolNetwork": { "type": "string" } }, "$$ref": "#/components/schemas/DHCPPool" }, "DNSSettings": { "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])(%[\\p{N}\\p{L}]+)?)((\\s)(([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])(%[\\p{N}\\p{L}]+)?)?$", "type": "string" }, "NTPSettings": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "string" } }, "NATRules": { "type": "array", "items": { "required": [ "description", "inPort", "insideIp", "interface", "outPort", "protocol" ], "type": "object", "properties": { "description": { "type": "string" }, "inPort": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "insideIp": { "type": "string" }, "interface": { "type": "string" }, "outPort": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "protocol": { "pattern": "^udp$|^tcp$|^icmp$", "type": "string" } }, "$$ref": "#/components/schemas/NATRule" } }, "NTPInherit": { "type": "boolean" } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/NetworkProtocol" } }, "$$ref": "#/components/schemas/getSingleMobilityGlobalNetworkprotocolPayload" }, "examples": { "NetworkProtocol Profile Parcel For Mobility Global Feature Profile": { "description": "NetworkProtocol Profile Parcel For Mobility Global Feature Profile", "value": { "type": "networkProtocol", "DNSSettings": "1.1.1.1", "NTPInherit": false, "NTPSettings": [ "1.1.1.1", "1.1.1.2" ], "DHCPPool": { "poolNetwork": "192.168.0.0/24", "leaseTime": "2", "startAddress": "1.1.1.2", "endAddress": "1.1.1.3" }, "DHCPOptions": [ { "type": 2, "dataType": "integer", "dhcpValue": "2" } ], "NATRules": [ { "protocol": "udp", "outPort": 23, "inPort": 2, "insideIp": "1.1.1.1", "description": "test" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-read" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a Network Protocol Profile Parcel for Mobility Global Feature Profile", "operationId": "DeleteNetworkProtocolProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "networkProtocolId", "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 > Teleworker > NetworkProtocol-write" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Edit an Network Protocol Profile Parcel for Mobility Global Feature Profile", "operationId": "EditNetworkProtocolProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "networkProtocolId", "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": "Network Protocol Profile Parcel", "content": { "application/json": { "schema": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "DHCPPool": { "required": [ "leaseTimeDay", "leaseTimeHour", "leaseTimeMin", "poolNetwork" ], "type": "object", "properties": { "leaseTimeDay": { "maximum": 365, "minimum": 0, "type": "integer", "format": "int32" }, "leaseTimeHour": { "maximum": 23, "minimum": 0, "type": "integer", "format": "int32" }, "leaseTimeMin": { "maximum": 59, "minimum": 0, "type": "integer", "format": "int32" }, "poolNetwork": { "type": "string" } }, "$$ref": "#/components/schemas/DHCPPool" }, "DNSSettings": { "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])(%[\\p{N}\\p{L}]+)?)((\\s)(([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])(%[\\p{N}\\p{L}]+)?)?$", "type": "string" }, "NTPSettings": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "string" } }, "NATRules": { "type": "array", "items": { "required": [ "description", "inPort", "insideIp", "interface", "outPort", "protocol" ], "type": "object", "properties": { "description": { "type": "string" }, "inPort": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "insideIp": { "type": "string" }, "interface": { "type": "string" }, "outPort": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "protocol": { "pattern": "^udp$|^tcp$|^icmp$", "type": "string" } }, "$$ref": "#/components/schemas/NATRule" } }, "NTPInherit": { "type": "boolean" } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/NetworkProtocol" }, "examples": { "Network Protocol Profile Parcel For Mobility Global Feature Profile": { "description": "Network Protocol Profile Parcel For Mobility Global Feature Profile", "value": { "type": "networkProtocol", "DNSSettings": "1.1.1.1", "NTPInherit": true, "DHCPPool": { "poolNetwork": "192.168.0.0/24", "leaseTime": "2", "startAddress": "1.1.1.2", "endAddress": "1.1.1.3" }, "DHCPOptions": [ { "type": 2, "dataType": "integer", "dhcpValue": "2" } ], "NATRules": [ { "protocol": "udp", "outPort": 23, "inPort": 2, "insideIp": "1.1.1.1", "description": "test" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > NetworkProtocol-write" } }, "/v1/feature-profile/mobility/global/{profileId}/securityPolicy": { "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create an SecurityPolicy Profile Parcel for Mobility Global Feature Profile", "operationId": "CreateSecurityPolicyProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "SecurityPolicy Profile Parcel", "content": { "application/json": { "schema": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "policyName": { "type": "string" }, "defaultAction": { "pattern": "(drop|pass)", "type": "string" }, "policyRules": { "type": "array", "items": { "type": "object", "properties": { "action": { "pattern": "(drop|pass)", "type": "string" }, "destIp": { "type": "string" }, "destPort": { "type": "integer", "format": "int32" }, "protocolType": { "type": "array", "items": { "type": "string" } }, "sourceIp": { "type": "string" }, "sourcePort": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/PolicyRule" } } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/SecurityPolicy" }, "examples": { "SecurityPolicy Profile Parcel For Mobility Global Feature Profile": { "description": "SecurityPolicy Profile Parcel For Mobility Global Feature Profile", "value": { "type": "securityPolicy", "policyName": "security-policy", "defaultAction": "pass", "policyRules": [ { "protocolType": [ "tcp", "udp" ], "sourceIp": "10.10.1.2/32", "destIp": "10.10.10.1/32", "sourcePort": 2000, "destPort": 3000, "action": "pass" }, { "protocolType": [ "icmp" ], "sourceIp": "11.11.1.1/32", "destIp": "11.11.2.2/32", "action": "drop" }, { "protocolType": [ "tcp" ], "sourceIp": "12.12.1.1/32", "destIp": "12.12.5.1/32", "sourcePort": 4000, "destPort": 5000, "action": "pass" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post response example": { "description": "post response example", "value": { "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-write" }, "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get an Mobility SecurityPolicy Profile Parcel list for Mobility Global Feature Profile", "operationId": "GetSecurityPolicyProfileParcelListForMobility", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "policyName": { "type": "string" }, "defaultAction": { "pattern": "(drop|pass)", "type": "string" }, "policyRules": { "type": "array", "items": { "type": "object", "properties": { "action": { "pattern": "(drop|pass)", "type": "string" }, "destIp": { "type": "string" }, "destPort": { "type": "integer", "format": "int32" }, "protocolType": { "type": "array", "items": { "type": "string" } }, "sourceIp": { "type": "string" }, "sourcePort": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/PolicyRule" } } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/SecurityPolicy" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalSecuritypolicyPayload" }, "examples": { "SecurityPolicy Profile Parcel For Mobility Global Feature Profile": { "description": "SecurityPolicy Profile Parcel For Mobility Global Feature Profile", "value": { "header": { "generatedOn": 1628729560981 }, "data": [ { "parcelId": "b79d5ede-263f-4229-aa9b-7b6581058c50", "parcelType": "securityPolicy", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1628729517699, "lastUpdatedOn": 1628729517699, "payload": { "policyName": "security-policy", "defaultAction": "pass", "policyRules": [ { "protocolType": [ "tcp", "udp" ], "sourceIp": "10.10.1.2/32", "destIp": "10.10.10.1/32", "sourcePort": 2000, "destPort": 3000, "action": "pass" }, { "protocolType": [ "icmp" ], "sourceIp": "11.11.1.1/32", "destIp": "11.11.2.2/32", "action": "drop" }, { "protocolType": [ "tcp" ], "sourceIp": "12.12.1.1/32", "destIp": "12.12.5.1/32", "sourcePort": 4000, "destPort": 5000, "action": "pass" } ], "type": "securityPolicy" } } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-read" } }, "/v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get an Mobility SecurityPolicy Profile Parcel for Mobility Global Feature Profile", "operationId": "GetSecurityPolicyProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "securityPolicyId", "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": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "policyName": { "type": "string" }, "defaultAction": { "pattern": "(drop|pass)", "type": "string" }, "policyRules": { "type": "array", "items": { "type": "object", "properties": { "action": { "pattern": "(drop|pass)", "type": "string" }, "destIp": { "type": "string" }, "destPort": { "type": "integer", "format": "int32" }, "protocolType": { "type": "array", "items": { "type": "string" } }, "sourceIp": { "type": "string" }, "sourcePort": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/PolicyRule" } } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/SecurityPolicy" } }, "$$ref": "#/components/schemas/getSingleMobilityGlobalSecuritypolicyPayload" }, "examples": { "SecurityPolicy Profile Parcel For Mobility Global Feature Profile": { "description": "SecurityPolicy Profile Parcel For Mobility Global Feature Profile", "value": { "type": "securityPolicy", "policyName": "security-policy", "defaultAction": "pass", "policyRules": [ { "protocolType": [ "tcp", "udp" ], "sourceIp": "10.10.1.2/32", "destIp": "10.10.10.1/32", "sourcePort": 2000, "destPort": 3000, "action": "pass" }, { "protocolType": [ "icmp" ], "sourceIp": "11.11.1.1/32", "destIp": "11.11.2.2/32", "action": "drop" }, { "protocolType": [ "tcp" ], "sourceIp": "12.12.1.1/32", "destIp": "12.12.5.1/32", "sourcePort": 4000, "destPort": 5000, "action": "pass" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-read" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a Security Policy Profile Parcel for Mobility Global Feature Profile", "operationId": "DeleteSecurityPolicyProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "securityPolicyId", "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 > Teleworker > SecurityPolicy-write" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Edit an Security Policy Profile Parcel for Mobility Global Feature Profile", "operationId": "EditSecurityPolicyProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "securityPolicyId", "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": "Security Policy Profile Parcel", "content": { "application/json": { "schema": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "policyName": { "type": "string" }, "defaultAction": { "pattern": "(drop|pass)", "type": "string" }, "policyRules": { "type": "array", "items": { "type": "object", "properties": { "action": { "pattern": "(drop|pass)", "type": "string" }, "destIp": { "type": "string" }, "destPort": { "type": "integer", "format": "int32" }, "protocolType": { "type": "array", "items": { "type": "string" } }, "sourceIp": { "type": "string" }, "sourcePort": { "type": "integer", "format": "int32" } }, "$$ref": "#/components/schemas/PolicyRule" } } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/SecurityPolicy" }, "examples": { "Security Policy Profile Parcel For Mobility Global Feature Profile": { "description": "Security Policy Profile Parcel For Mobility Global Feature Profile", "value": { "type": "securityPolicy", "policyName": "security-policy", "defaultAction": "pass", "policyRules": [ { "protocolType": [ "tcp", "udp" ], "sourceIp": "10.10.1.2/32", "destIp": "10.10.10.1/32", "sourcePort": 2000, "destPort": 3000, "action": "pass" }, { "protocolType": [ "icmp" ], "sourceIp": "11.11.1.1/32", "destIp": "11.11.2.2/32", "action": "drop" }, { "protocolType": [ "tcp" ], "sourceIp": "12.12.1.1/32", "destIp": "12.12.5.1/32", "sourcePort": 4000, "destPort": 5000, "action": "pass" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > SecurityPolicy-write" } }, "/v1/feature-profile/mobility/global/{profileId}/vpn": { "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create a VPN Profile Parcel for Mobility Global Feature Profile", "operationId": "CreateVpnProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "VPN Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "vpnTunnels": { "type": "array", "description": "Container to provide multiple VPN tunnels configurations", "minItems": 1, "maxItems": 1, "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "vpnTunnelInfo": { "type": "object", "description": "Provide specific tunnel information", "properties": { "name": { "description": "Tunnel Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^ipsec[1-5]$", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_tunnelNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfTunnelNameOptionsDef" }, "description": { "description": "Tunnel Description", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^[^<> ]*$", "minLength": 1, "maxLength": 127, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_tunnelDescriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfTunnelDescriptionOptionsDef" }, "privateSubnets": { "description": "Container for Local and Remote Private Subnets", "type": "object", "oneOf": [ { "type": "object", "properties": { "remotePrivateSubnets": { "description": "Remote Private Subnet", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 75, "additionalProperties": false, "items": { "type": "string", "pattern": "^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$" }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_listOfIpv4RemotePrivateSubnetsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfListOfIpv4RemotePrivateSubnetsOptionsDef" }, "localPrivateSubnet": { "description": "Local Private Subnet", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ipv4LocalPrivateSubnetsDef" } }, "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/ProfileparcelMobilityGlobalVpnPostRequest_oneOfLocalPrivateSubnetOptionsDef" } }, "additionalProperties": false, "required": [ "remotePrivateSubnets", "localPrivateSubnet" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_staticLocalRemotePrivateSubnetDef" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfPrivateSubnetsDef" }, "preSharedSecret": { "description": "Preshared Secret", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^(?!.*[!#]).*", "minLength": 1, "maxLength": 127, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_preSharedSecretInputDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfPresharedSecretOptionsDef" }, "remotePublicIp": { "description": "Remote Public IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "additionalProperties": false, "items": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" } ] }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_listOfIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfRemotePublicIpOptionsDef" }, "tunnelDnsAddress": { "description": "List of Tunnel DNS Addresses", "type": "object", "oneOf": [ { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "additionalProperties": false, "items": { "type": "string", "format": "ipv4" }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_listOfIpv4DNSAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfListOfIpv4TunnelDnsAddressesOptionsDef" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfTunnelDnsAddressOptionsDef" }, "localInterface": { "description": "Local Interface", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "Cellular1/0", "GigabitEthernet0/0" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_localInterfaceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfLocalInterfaceOptionsDef" }, "tunnelRedundancyConfiguration": { "description": "Container for Fields Related to Redundancy Configuration", "type": "object", "properties": { "secondaryRemotePublicIp": { "description": "Secondary Remote Public IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_secondaryIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfSecondaryRemotePublicIpOptionsDef" }, "dpdInterval": { "description": "Dead Peer Detection Interval", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 65535, "minimum": 0, "type": "integer", "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdIntervalDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfDpdIntervalOptionsDef" }, "dpdRetries": { "description": "Dead Peer Detection Retries", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 255, "minimum": 0, "type": "integer", "default": 3, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdRetriesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 3, "minimum": 3, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdRetriesDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfDpdRetriesOptionsDef" } }, "additionalProperties": false, "required": [ "secondaryRemotePublicIp" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_tunnelRedundancyConfigDef" } }, "required": [ "name", "preSharedSecret", "remotePublicIp", "localInterface" ], "additionalProperties": false }, "ipSecPolicy": { "type": "object", "description": "Provide IPSEC policy information", "properties": { "ikePhase1": { "type": "object", "description": "IKE Phase 1", "properties": { "cipherSuite": { "description": "IKE Phase 1 Cipher Suite", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "aes128-cbc-sha1" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase1CipherSuiteDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes128-cbc-sha1", "aes256-cbc-sha1", "aes128-cbc-sha256", "aes256-cbc-sha256", "aes128-gcm", "aes256-gcm" ], "type": "string", "default": "aes128-cbc-sha1", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase1CipherSuiteDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkePhase1CipherSuiteOptionsDef" }, "ikeVersion": { "description": "IKE Phase 1 Version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 2, "minimum": 2, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikeVersionDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkeVersionOptionsDef" }, "diffeHellmanGroup": { "description": "IKE Phase 1 Diffe-Hellman Group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "14", "15", "16", "19", "20", "21" ], "type": "string", "default": "14", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_diffeHellmanGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "14" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_diffeHellmanGroupDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfDiffeHellmanGroupOptionsDef" }, "rekeyTimer": { "description": "IKE Phase 1 Rekey Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 1209600, "minimum": 300, "type": "integer", "default": 7200, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_rekeyTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 7200, "minimum": 7200, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_rekeyTimerDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfRekeyTimerOptionsDef" } }, "required": [ "cipherSuite", "diffeHellmanGroup" ], "additionalProperties": false }, "ikePhase2CipherSuite": { "description": "Ike Phase 2 Cipher Suite", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "aes128-sha1" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2CipherSuiteDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes128-sha1", "aes128-cbc-sha1", "aes256-cbc-sha1", "aes128-cbc-sha256", "aes256-cbc-sha256", "aes128-gcm", "aes256-gcm" ], "type": "string", "default": "aes128-sha1", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2CipherSuiteDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkePhase2CipherSuiteOptionsDef" }, "ikePhase2RekeyTimer": { "description": "Ike Phase 2 Rekey Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 1209600, "minimum": 300, "type": "integer", "default": 7200, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2RekeyTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 7200, "minimum": 7200, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2RekeyDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkePhase2RekeyTimerOptionsDef" } }, "required": [ "ikePhase1", "ikePhase2CipherSuite" ], "additionalProperties": false } }, "required": [ "vpnTunnelInfo", "ipSecPolicy" ], "additionalProperties": false } } }, "required": [ "vpnTunnels" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_SchemaPayload" }, "examples": { "AonVPNParcelConfig": { "value": { "data": { "vpnTunnels": [ { "vpnTunnelInfo": { "name": { "optionType": "global", "value": "ipsec1" }, "description": { "optionType": "global", "value": "ipsec1TunnelConfiguration" }, "privateSubnets": { "remotePrivateSubnets": { "optionType": "global", "value": [ "1.0.0.0/1", "2.0.0.0/1" ] }, "localPrivateSubnet": { "optionType": "variable", "value": "{{local-private-subnet}}" } }, "preSharedSecret": { "optionType": "global", "value": "$ecret@" }, "remotePublicIp": { "optionType": "global", "value": [ "1.0.0.0" ] }, "tunnelDnsAddress": { "optionType": "global", "value": [ "2.0.0.0" ] }, "localInterface": { "optionType": "global", "value": "Cellular1/0" }, "tunnelRedundancyConfiguration": { "secondaryRemotePublicIp": { "optionType": "global", "value": "5.4.3.2" }, "dpdInterval": { "optionType": "global", "value": 30 }, "dpdRetries": { "optionType": "global", "value": 20 } } }, "ipSecPolicy": { "ikePhase1": { "cipherSuite": { "optionType": "default", "value": "aes128-cbc-sha1" }, "ikeVersion": { "optionType": "default", "value": 2 }, "diffeHellmanGroup": { "optionType": "global", "value": "14" }, "rekeyTimer": { "optionType": "global", "value": 1209600 } }, "ikePhase2CipherSuite": { "optionType": "default", "value": "aes128-sha1" }, "ikePhase2RekeyTimer": { "optionType": "global", "value": 1209600 } } } ] }, "description": "Aon VPN Parcel config", "name": "AonVPNParcelConfig" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalVpnPostRequest_AonVPNParcelConfig" } } } }, "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 > Teleworker > Vpn-write" }, "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get VPN Profile Parcels for Mobility Global Feature Profile", "operationId": "GetVpnProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "vpnTunnels": { "type": "array", "description": "Container to provide multiple VPN tunnels configurations", "minItems": 1, "maxItems": 1, "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "vpnTunnelInfo": { "type": "object", "description": "Provide specific tunnel information", "properties": { "name": { "description": "Tunnel Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^ipsec[1-5]$", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_tunnelNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfTunnelNameOptionsDef" }, "description": { "description": "Tunnel Description", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^[^<> ]*$", "minLength": 1, "maxLength": 127, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_tunnelDescriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfTunnelDescriptionOptionsDef" }, "privateSubnets": { "description": "Container for Local and Remote Private Subnets", "type": "object", "oneOf": [ { "type": "object", "properties": { "remotePrivateSubnets": { "description": "Remote Private Subnet", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 75, "additionalProperties": false, "items": { "type": "string", "pattern": "^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$" }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_listOfIpv4RemotePrivateSubnetsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfListOfIpv4RemotePrivateSubnetsOptionsDef" }, "localPrivateSubnet": { "description": "Local Private Subnet", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ipv4LocalPrivateSubnetsDef" } }, "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/ProfileparcelMobilityGlobalVpnPostRequest_oneOfLocalPrivateSubnetOptionsDef" } }, "additionalProperties": false, "required": [ "remotePrivateSubnets", "localPrivateSubnet" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_staticLocalRemotePrivateSubnetDef" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfPrivateSubnetsDef" }, "preSharedSecret": { "description": "Preshared Secret", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^(?!.*[!#]).*", "minLength": 1, "maxLength": 127, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_preSharedSecretInputDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfPresharedSecretOptionsDef" }, "remotePublicIp": { "description": "Remote Public IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "additionalProperties": false, "items": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" } ] }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_listOfIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfRemotePublicIpOptionsDef" }, "tunnelDnsAddress": { "description": "List of Tunnel DNS Addresses", "type": "object", "oneOf": [ { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "additionalProperties": false, "items": { "type": "string", "format": "ipv4" }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_listOfIpv4DNSAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfListOfIpv4TunnelDnsAddressesOptionsDef" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfTunnelDnsAddressOptionsDef" }, "localInterface": { "description": "Local Interface", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "Cellular1/0", "GigabitEthernet0/0" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_localInterfaceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfLocalInterfaceOptionsDef" }, "tunnelRedundancyConfiguration": { "description": "Container for Fields Related to Redundancy Configuration", "type": "object", "properties": { "secondaryRemotePublicIp": { "description": "Secondary Remote Public IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_secondaryIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfSecondaryRemotePublicIpOptionsDef" }, "dpdInterval": { "description": "Dead Peer Detection Interval", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 65535, "minimum": 0, "type": "integer", "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdIntervalDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfDpdIntervalOptionsDef" }, "dpdRetries": { "description": "Dead Peer Detection Retries", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 255, "minimum": 0, "type": "integer", "default": 3, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdRetriesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 3, "minimum": 3, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdRetriesDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfDpdRetriesOptionsDef" } }, "additionalProperties": false, "required": [ "secondaryRemotePublicIp" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_tunnelRedundancyConfigDef" } }, "required": [ "name", "preSharedSecret", "remotePublicIp", "localInterface" ], "additionalProperties": false }, "ipSecPolicy": { "type": "object", "description": "Provide IPSEC policy information", "properties": { "ikePhase1": { "type": "object", "description": "IKE Phase 1", "properties": { "cipherSuite": { "description": "IKE Phase 1 Cipher Suite", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "aes128-cbc-sha1" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase1CipherSuiteDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes128-cbc-sha1", "aes256-cbc-sha1", "aes128-cbc-sha256", "aes256-cbc-sha256", "aes128-gcm", "aes256-gcm" ], "type": "string", "default": "aes128-cbc-sha1", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase1CipherSuiteDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkePhase1CipherSuiteOptionsDef" }, "ikeVersion": { "description": "IKE Phase 1 Version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 2, "minimum": 2, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikeVersionDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkeVersionOptionsDef" }, "diffeHellmanGroup": { "description": "IKE Phase 1 Diffe-Hellman Group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "14", "15", "16", "19", "20", "21" ], "type": "string", "default": "14", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_diffeHellmanGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "14" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_diffeHellmanGroupDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfDiffeHellmanGroupOptionsDef" }, "rekeyTimer": { "description": "IKE Phase 1 Rekey Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 1209600, "minimum": 300, "type": "integer", "default": 7200, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_rekeyTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 7200, "minimum": 7200, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_rekeyTimerDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfRekeyTimerOptionsDef" } }, "required": [ "cipherSuite", "diffeHellmanGroup" ], "additionalProperties": false }, "ikePhase2CipherSuite": { "description": "Ike Phase 2 Cipher Suite", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "aes128-sha1" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2CipherSuiteDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes128-sha1", "aes128-cbc-sha1", "aes256-cbc-sha1", "aes128-cbc-sha256", "aes256-cbc-sha256", "aes128-gcm", "aes256-gcm" ], "type": "string", "default": "aes128-sha1", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2CipherSuiteDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkePhase2CipherSuiteOptionsDef" }, "ikePhase2RekeyTimer": { "description": "Ike Phase 2 Rekey Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 1209600, "minimum": 300, "type": "integer", "default": 7200, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2RekeyTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 7200, "minimum": 7200, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2RekeyDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkePhase2RekeyTimerOptionsDef" } }, "required": [ "ikePhase1", "ikePhase2CipherSuite" ], "additionalProperties": false } }, "required": [ "vpnTunnelInfo", "ipSecPolicy" ], "additionalProperties": false } } }, "required": [ "vpnTunnels" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_SchemaPayload" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalVpnPayload" }, "examples": { "get response example": { "value": { "header": { "generatedOn": 1702438718825 }, "data": [ { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "vpn", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "vpnTunnels": [ { "vpnTunnelInfo": { "name": { "optionType": "global", "value": "ipsec1" }, "description": { "optionType": "global", "value": "ipsec1TunnelConfiguration" }, "privateSubnets": { "remotePrivateSubnets": { "optionType": "global", "value": [ "1.0.0.0/1", "2.0.0.0/1" ] }, "localPrivateSubnet": { "optionType": "variable", "value": "{{local-private-subnet}}" } }, "preSharedSecret": { "optionType": "global", "value": "$ecret@" }, "remotePublicIp": { "optionType": "global", "value": [ "1.0.0.0" ] }, "tunnelDnsAddress": { "optionType": "global", "value": [ "2.0.0.0" ] }, "localInterface": { "optionType": "global", "value": "Cellular1/0" }, "tunnelRedundancyConfiguration": { "secondaryRemotePublicIp": { "optionType": "global", "value": "5.4.3.2" }, "dpdInterval": { "optionType": "global", "value": 30 }, "dpdRetries": { "optionType": "global", "value": 20 } } }, "ipSecPolicy": { "ikePhase1": { "cipherSuite": { "optionType": "default", "value": "aes128-cbc-sha1" }, "ikeVersion": { "optionType": "default", "value": 2 }, "diffeHellmanGroup": { "optionType": "global", "value": "14" }, "rekeyTimer": { "optionType": "global", "value": 1209600 } }, "ikePhase2CipherSuite": { "optionType": "default", "value": "aes128-sha1" }, "ikePhase2RekeyTimer": { "optionType": "global", "value": 1209600 } } } ] } } } ] }, "$$ref": "#/components/examples/getListMobilityGlobalVpnExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Vpn-read" } }, "/v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId}": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get VPN Profile Parcel by parcelId for Mobility Global Feature Profile", "operationId": "GetVpnProfileParcelByParcelIdForMobility", "parameters": [ { "name": "profileId", "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": "vpnId", "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": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "vpnTunnels": { "type": "array", "description": "Container to provide multiple VPN tunnels configurations", "minItems": 1, "maxItems": 1, "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "vpnTunnelInfo": { "type": "object", "description": "Provide specific tunnel information", "properties": { "name": { "description": "Tunnel Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^ipsec[1-5]$", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_tunnelNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfTunnelNameOptionsDef" }, "description": { "description": "Tunnel Description", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^[^<> ]*$", "minLength": 1, "maxLength": 127, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_tunnelDescriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfTunnelDescriptionOptionsDef" }, "privateSubnets": { "description": "Container for Local and Remote Private Subnets", "type": "object", "oneOf": [ { "type": "object", "properties": { "remotePrivateSubnets": { "description": "Remote Private Subnet", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 75, "additionalProperties": false, "items": { "type": "string", "pattern": "^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$" }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_listOfIpv4RemotePrivateSubnetsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfListOfIpv4RemotePrivateSubnetsOptionsDef" }, "localPrivateSubnet": { "description": "Local Private Subnet", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ipv4LocalPrivateSubnetsDef" } }, "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/ProfileparcelMobilityGlobalVpnPutRequest_oneOfLocalPrivateSubnetOptionsDef" } }, "additionalProperties": false, "required": [ "remotePrivateSubnets", "localPrivateSubnet" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_staticLocalRemotePrivateSubnetDef" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfPrivateSubnetsDef" }, "preSharedSecret": { "description": "Preshared Secret", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^(?!.*[!#]).*", "minLength": 1, "maxLength": 127, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_preSharedSecretInputDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfPresharedSecretOptionsDef" }, "remotePublicIp": { "description": "Remote Public IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "additionalProperties": false, "items": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" } ] }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_listOfIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfRemotePublicIpOptionsDef" }, "tunnelDnsAddress": { "description": "List of Tunnel DNS Addresses", "type": "object", "oneOf": [ { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "additionalProperties": false, "items": { "type": "string", "format": "ipv4" }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_listOfIpv4DNSAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfListOfIpv4TunnelDnsAddressesOptionsDef" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfTunnelDnsAddressOptionsDef" }, "localInterface": { "description": "Local Interface", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "Cellular1/0", "GigabitEthernet0/0" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_localInterfaceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfLocalInterfaceOptionsDef" }, "tunnelRedundancyConfiguration": { "description": "Container for Fields Related to Redundancy Configuration", "type": "object", "properties": { "secondaryRemotePublicIp": { "description": "Secondary Remote Public IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_secondaryIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfSecondaryRemotePublicIpOptionsDef" }, "dpdInterval": { "description": "Dead Peer Detection Interval", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 65535, "minimum": 0, "type": "integer", "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_dpdIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_dpdIntervalDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfDpdIntervalOptionsDef" }, "dpdRetries": { "description": "Dead Peer Detection Retries", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 255, "minimum": 0, "type": "integer", "default": 3, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_dpdRetriesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 3, "minimum": 3, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_dpdRetriesDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfDpdRetriesOptionsDef" } }, "additionalProperties": false, "required": [ "secondaryRemotePublicIp" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_tunnelRedundancyConfigDef" } }, "required": [ "name", "preSharedSecret", "remotePublicIp", "localInterface" ], "additionalProperties": false }, "ipSecPolicy": { "type": "object", "description": "Provide IPSEC policy information", "properties": { "ikePhase1": { "type": "object", "description": "IKE Phase 1", "properties": { "cipherSuite": { "description": "IKE Phase 1 Cipher Suite", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "aes128-cbc-sha1" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase1CipherSuiteDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes128-cbc-sha1", "aes256-cbc-sha1", "aes128-cbc-sha256", "aes256-cbc-sha256", "aes128-gcm", "aes256-gcm" ], "type": "string", "default": "aes128-cbc-sha1", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase1CipherSuiteDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfIkePhase1CipherSuiteOptionsDef" }, "ikeVersion": { "description": "IKE Phase 1 Version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 2, "minimum": 2, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikeVersionDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfIkeVersionOptionsDef" }, "diffeHellmanGroup": { "description": "IKE Phase 1 Diffe-Hellman Group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "14", "15", "16", "19", "20", "21" ], "type": "string", "default": "14", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_diffeHellmanGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "14" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_diffeHellmanGroupDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfDiffeHellmanGroupOptionsDef" }, "rekeyTimer": { "description": "IKE Phase 1 Rekey Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 1209600, "minimum": 300, "type": "integer", "default": 7200, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_rekeyTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 7200, "minimum": 7200, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_rekeyTimerDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfRekeyTimerOptionsDef" } }, "required": [ "cipherSuite", "diffeHellmanGroup" ], "additionalProperties": false }, "ikePhase2CipherSuite": { "description": "Ike Phase 2 Cipher Suite", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "aes128-sha1" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase2CipherSuiteDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes128-sha1", "aes128-cbc-sha1", "aes256-cbc-sha1", "aes128-cbc-sha256", "aes256-cbc-sha256", "aes128-gcm", "aes256-gcm" ], "type": "string", "default": "aes128-sha1", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase2CipherSuiteDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfIkePhase2CipherSuiteOptionsDef" }, "ikePhase2RekeyTimer": { "description": "Ike Phase 2 Rekey Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 1209600, "minimum": 300, "type": "integer", "default": 7200, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase2RekeyTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 7200, "minimum": 7200, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase2RekeyDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfIkePhase2RekeyTimerOptionsDef" } }, "required": [ "ikePhase1", "ikePhase2CipherSuite" ], "additionalProperties": false } }, "required": [ "vpnTunnelInfo", "ipSecPolicy" ], "additionalProperties": false } } }, "required": [ "vpnTunnels" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_SchemaPayload" } }, "$$ref": "#/components/schemas/getSingleMobilityGlobalVpnPayload" }, "examples": { "get response example": { "value": { "parcelId": "09fc54fe-ff36-4640-ae57-c9e71a103902", "parcelType": "vpn", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1701866357838, "lastUpdatedOn": 1701866357838, "payload": { "data": { "vpnTunnels": [ { "vpnTunnelInfo": { "name": { "optionType": "global", "value": "ipsec1" }, "description": { "optionType": "global", "value": "ipsec1TunnelConfiguration" }, "privateSubnets": { "remotePrivateSubnets": { "optionType": "global", "value": [ "1.0.0.0/1", "2.0.0.0/1" ] }, "localPrivateSubnet": { "optionType": "variable", "value": "{{local-private-subnet}}" } }, "preSharedSecret": { "optionType": "global", "value": "$ecret@" }, "remotePublicIp": { "optionType": "global", "value": [ "1.0.0.0" ] }, "tunnelDnsAddress": { "optionType": "global", "value": [ "2.0.0.0" ] }, "localInterface": { "optionType": "global", "value": "Cellular1/0" }, "tunnelRedundancyConfiguration": { "secondaryRemotePublicIp": { "optionType": "global", "value": "5.4.3.2" }, "dpdInterval": { "optionType": "global", "value": 30 }, "dpdRetries": { "optionType": "global", "value": 20 } } }, "ipSecPolicy": { "ikePhase1": { "cipherSuite": { "optionType": "default", "value": "aes128-cbc-sha1" }, "ikeVersion": { "optionType": "default", "value": 2 }, "diffeHellmanGroup": { "optionType": "global", "value": "14" }, "rekeyTimer": { "optionType": "global", "value": 1209600 } }, "ikePhase2CipherSuite": { "optionType": "default", "value": "aes128-sha1" }, "ikePhase2RekeyTimer": { "optionType": "global", "value": 1209600 } } } ] } } }, "$$ref": "#/components/examples/getSingleMobilityGlobalVpnExample" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Vpn-read" }, "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Update a VPN Profile Parcel for Mobility Global Feature Profile", "operationId": "EditVpnProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "vpnId", "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": "VPN Profile Parcel", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^&<>! \"]+$", "minLength": 1, "maxLength": 128, "$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef", "description": "Set the parcel name" }, "description": { "description": "Set the parcel description", "type": "string" }, "data": { "type": "object", "properties": { "vpnTunnels": { "type": "array", "description": "Container to provide multiple VPN tunnels configurations", "minItems": 1, "maxItems": 1, "uniqueItems": true, "additionalProperties": false, "items": { "type": "object", "properties": { "vpnTunnelInfo": { "type": "object", "description": "Provide specific tunnel information", "properties": { "name": { "description": "Tunnel Name", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^ipsec[1-5]$", "minLength": 1, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_tunnelNameDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfTunnelNameOptionsDef" }, "description": { "description": "Tunnel Description", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^[^<> ]*$", "minLength": 1, "maxLength": 127, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_tunnelDescriptionDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfTunnelDescriptionOptionsDef" }, "privateSubnets": { "description": "Container for Local and Remote Private Subnets", "type": "object", "oneOf": [ { "type": "object", "properties": { "remotePrivateSubnets": { "description": "Remote Private Subnet", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 75, "additionalProperties": false, "items": { "type": "string", "pattern": "^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$" }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_listOfIpv4RemotePrivateSubnetsDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfListOfIpv4RemotePrivateSubnetsOptionsDef" }, "localPrivateSubnet": { "description": "Local Private Subnet", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ipv4LocalPrivateSubnetsDef" } }, "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/ProfileparcelMobilityGlobalVpnPutRequest_oneOfLocalPrivateSubnetOptionsDef" } }, "additionalProperties": false, "required": [ "remotePrivateSubnets", "localPrivateSubnet" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_staticLocalRemotePrivateSubnetDef" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfPrivateSubnetsDef" }, "preSharedSecret": { "description": "Preshared Secret", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "string", "pattern": "^(?!.*[!#]).*", "minLength": 1, "maxLength": 127, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_preSharedSecretInputDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfPresharedSecretOptionsDef" }, "remotePublicIp": { "description": "Remote Public IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "additionalProperties": false, "items": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" } ] }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_listOfIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfRemotePublicIpOptionsDef" }, "tunnelDnsAddress": { "description": "List of Tunnel DNS Addresses", "type": "object", "oneOf": [ { "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "type": "array", "uniqueItems": true, "minItems": 1, "maxItems": 1, "additionalProperties": false, "items": { "type": "string", "format": "ipv4" }, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_listOfIpv4DNSAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfListOfIpv4TunnelDnsAddressesOptionsDef" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfTunnelDnsAddressOptionsDef" }, "localInterface": { "description": "Local Interface", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "Cellular1/0", "GigabitEthernet0/0" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_localInterfaceDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfLocalInterfaceOptionsDef" }, "tunnelRedundancyConfiguration": { "description": "Container for Fields Related to Redundancy Configuration", "type": "object", "properties": { "secondaryRemotePublicIp": { "description": "Secondary Remote Public IP Address", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "anyOf": [ { "type": "string", "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 }, { "type": "string", "format": "ipv4" } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_secondaryIpv4OrDomainNameRemotePublicIpAddressesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfSecondaryRemotePublicIpOptionsDef" }, "dpdInterval": { "description": "Dead Peer Detection Interval", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 65535, "minimum": 0, "type": "integer", "default": 10, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_dpdIntervalDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 10, "minimum": 10, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_dpdIntervalDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfDpdIntervalOptionsDef" }, "dpdRetries": { "description": "Dead Peer Detection Retries", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 255, "minimum": 0, "type": "integer", "default": 3, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_dpdRetriesDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 3, "minimum": 3, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_dpdRetriesDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfDpdRetriesOptionsDef" } }, "additionalProperties": false, "required": [ "secondaryRemotePublicIp" ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_tunnelRedundancyConfigDef" } }, "required": [ "name", "preSharedSecret", "remotePublicIp", "localInterface" ], "additionalProperties": false }, "ipSecPolicy": { "type": "object", "description": "Provide IPSEC policy information", "properties": { "ikePhase1": { "type": "object", "description": "IKE Phase 1", "properties": { "cipherSuite": { "description": "IKE Phase 1 Cipher Suite", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "aes128-cbc-sha1" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase1CipherSuiteDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes128-cbc-sha1", "aes256-cbc-sha1", "aes128-cbc-sha256", "aes256-cbc-sha256", "aes128-gcm", "aes256-gcm" ], "type": "string", "default": "aes128-cbc-sha1", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase1CipherSuiteDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfIkePhase1CipherSuiteOptionsDef" }, "ikeVersion": { "description": "IKE Phase 1 Version", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 2, "minimum": 2, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikeVersionDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfIkeVersionOptionsDef" }, "diffeHellmanGroup": { "description": "IKE Phase 1 Diffe-Hellman Group", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "14", "15", "16", "19", "20", "21" ], "type": "string", "default": "14", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_diffeHellmanGroupDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "14" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_diffeHellmanGroupDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfDiffeHellmanGroupOptionsDef" }, "rekeyTimer": { "description": "IKE Phase 1 Rekey Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 1209600, "minimum": 300, "type": "integer", "default": 7200, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_rekeyTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 7200, "minimum": 7200, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_rekeyTimerDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfRekeyTimerOptionsDef" } }, "required": [ "cipherSuite", "diffeHellmanGroup" ], "additionalProperties": false }, "ikePhase2CipherSuite": { "description": "Ike Phase 2 Cipher Suite", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "enum": [ "aes128-sha1" ], "type": "string", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase2CipherSuiteDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "enum": [ "aes128-sha1", "aes128-cbc-sha1", "aes256-cbc-sha1", "aes128-cbc-sha256", "aes256-cbc-sha256", "aes128-gcm", "aes256-gcm" ], "type": "string", "default": "aes128-sha1", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase2CipherSuiteDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfIkePhase2CipherSuiteOptionsDef" }, "ikePhase2RekeyTimer": { "description": "Ike Phase 2 Rekey Timer", "type": "object", "oneOf": [ { "properties": { "optionType": { "type": "string", "enum": [ "global" ], "$$ref": "#/components/schemas/CommonCommonDefs_globalOptionTypeDef" }, "value": { "maximum": 1209600, "minimum": 300, "type": "integer", "default": 7200, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase2RekeyTimerDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false }, { "properties": { "optionType": { "type": "string", "enum": [ "default" ], "$$ref": "#/components/schemas/CommonCommonDefs_defaultOptionTypeDef" }, "value": { "maximum": 7200, "minimum": 7200, "type": "integer", "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_ikePhase2RekeyDefaultDef" } }, "required": [ "optionType", "value" ], "additionalProperties": false } ], "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_oneOfIkePhase2RekeyTimerOptionsDef" } }, "required": [ "ikePhase1", "ikePhase2CipherSuite" ], "additionalProperties": false } }, "required": [ "vpnTunnelInfo", "ipSecPolicy" ], "additionalProperties": false } } }, "required": [ "vpnTunnels" ], "additionalProperties": false } }, "required": [ "name", "data" ], "x-metadata": { "minVManageVersion": "20.15.1" }, "additionalProperties": false, "$$ref": "#/components/schemas/ProfileparcelMobilityGlobalVpnPutRequest_SchemaPayload" }, "examples": { "AonVPNParcelConfig": { "value": { "data": { "vpnTunnels": [ { "vpnTunnelInfo": { "name": { "optionType": "global", "value": "ipsec1" }, "description": { "optionType": "global", "value": "ipsec1TunnelConfiguration" }, "privateSubnets": { "remotePrivateSubnets": { "optionType": "global", "value": [ "1.0.0.0/1", "2.0.0.0/1" ] }, "localPrivateSubnet": { "optionType": "variable", "value": "{{local-private-subnet}}" } }, "preSharedSecret": { "optionType": "global", "value": "$ecret@" }, "remotePublicIp": { "optionType": "global", "value": [ "1.0.0.0" ] }, "tunnelDnsAddress": { "optionType": "global", "value": [ "2.0.0.0" ] }, "localInterface": { "optionType": "global", "value": "Cellular1/0" }, "tunnelRedundancyConfiguration": { "secondaryRemotePublicIp": { "optionType": "global", "value": "5.4.3.2" }, "dpdInterval": { "optionType": "global", "value": 30 }, "dpdRetries": { "optionType": "global", "value": 20 } } }, "ipSecPolicy": { "ikePhase1": { "cipherSuite": { "optionType": "default", "value": "aes128-cbc-sha1" }, "ikeVersion": { "optionType": "default", "value": 2 }, "diffeHellmanGroup": { "optionType": "global", "value": "14" }, "rekeyTimer": { "optionType": "global", "value": 1209600 } }, "ikePhase2CipherSuite": { "optionType": "default", "value": "aes128-sha1" }, "ikePhase2RekeyTimer": { "optionType": "global", "value": 1209600 } } } ] }, "description": "Aon VPN Parcel config", "name": "AonVPNParcelConfig" }, "$$ref": "#/components/examples/ProfileparcelMobilityGlobalVpnPutRequest_AonVPNParcelConfig" } } } }, "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 > Teleworker > Vpn-write" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete a VPN Profile Parcel for Mobility Global Feature Profile", "operationId": "DeleteVpnProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "vpnId", "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 > Teleworker > Vpn-write" } }, "/v1/feature-profile/mobility/global/{profileId}/wifi": { "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get Wifi Profile Parcel List for Mobility feature profile", "operationId": "GetWifiProfileParcelListForMobility", "parameters": [ { "name": "profileId", "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": { "data": { "type": "array", "items": { "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": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "ssidConfigList": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "qosSettings": { "pattern": "(WLAN_QOS_BEST_EFFORT|WLAN_QOS_VIDEO|WLAN_QOS_VOICE|WLAN_QOS_BACKGROUND|WLAN_QOS_RESERVED)", "type": "string" }, "securityAuthType": { "pattern": "(OPEN|WPA2-PSK_AES)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/SSIDConfig" } }, "guestWifi": { "type": "object", "properties": { "securityAuthType": { "pattern": "(OPEN|WPA2-PSK_AES)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/GuestWifi" }, "corporateWifi": { "required": [ "securityAuthType" ], "type": "object", "properties": { "aaaServerInfo": { "required": [ "aaaServersParcelId", "radiusServerName" ], "type": "object", "properties": { "aaaServersParcelId": { "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" }, "radiusServerName": { "type": "string" } }, "$$ref": "#/components/schemas/AaaServerInfo" }, "corporateWlan": { "type": "boolean" }, "radiusServer": { "required": [ "host", "port", "secret" ], "type": "object", "properties": { "host": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "port": { "minimum": 0, "type": "integer", "format": "int32" }, "secret": { "type": "string" } }, "$$ref": "#/components/schemas/RadiusServer" }, "securityAuthType": { "pattern": "(WPA2-PSK_AES|WPA2-Enterprise)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/CorporateWifi" }, "advancedRadioSetting": { "type": "object", "properties": { "channelPowerSettings": { "type": "object", "properties": { "radioBand2Dot4Ghz": { "type": "object", "properties": { "band": { "pattern": "(RADIO_2_DOT_4_GHZ)", "type": "string" }, "channel": { "pattern": "(auto|1|2|3|4|5|6|7|8|9|10|11)", "type": "string" }, "channelWidth": { "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ)", "type": "string" }, "transmitPower": { "pattern": "(auto|1|2|3|4|5|6|7)", "type": "string" } }, "$$ref": "#/components/schemas/RadioBandSetting_2_4G" }, "radioBand5Ghz": { "type": "object", "properties": { "band": { "pattern": "(RADIO_5_GHZ)", "type": "string" }, "channel": { "pattern": "(auto|36|40|44|48|52|56|60|64|100|104|108|112|116|120|124|128|132|136|140|144|149|153|157|161|165)", "type": "string" }, "channelWidth": { "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ|RADIO_CHANNEL_WIDTH_40_MHZ|RADIO_CHANNEL_WIDTH_80_MHZ)", "type": "string" }, "transmitPower": { "pattern": "(auto|1|2|3|4|5|6|7)", "type": "string" } }, "$$ref": "#/components/schemas/RadioBandSetting_5G" } }, "$$ref": "#/components/schemas/ChannelPowerSettings" }, "countryRegionSettings": { "type": "object", "properties": { "countryRegion": { "type": "string" }, "regulatoryDomain": { "pattern": "(REG_DOMAIN_INVALID|REG_DOMAIN_A|REG_DOMAIN_B|REG_DOMAIN_C|REG_DOMAIN_D|REG_DOMAIN_E|REG_DOMAIN_F|REG_DOMAIN_G|REG_DOMAIN_H|REG_DOMAIN_I|REG_DOMAIN_J|REG_DOMAIN_K|REG_DOMAIN_L|REG_DOMAIN_M|REG_DOMAIN_N|REG_DOMAIN_P|REG_DOMAIN_Q|REG_DOMAIN_R|REG_DOMAIN_S|REG_DOMAIN_T|REG_DOMAIN_U|REG_DOMAIN_Z|REG_DOMAIN_NONE|REG_DOMAIN_ZZ)", "type": "string" } }, "$$ref": "#/components/schemas/CountryRegionSettings" } }, "$$ref": "#/components/schemas/AdvancedRadioSetting" } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/Wifi" } } } } }, "$$ref": "#/components/schemas/getListMobilityGlobalWifiPayload" }, "examples": { "Wifi Profile Parcel For Mobility Global Feature Profile": { "description": "Wifi Profile Parcel For Mobility Global Feature Profile", "value": { "header": { "generatedOn": 1628729177130 }, "data": [ { "parcelId": "70c55c19-5043-4c6f-9b64-d710ee174bfd", "parcelType": "wifi", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1628729108424, "lastUpdatedOn": 1628729108424, "payload": { "id": null, "name": null, "ssid0": { "ssid": "myWIFI", "security": "WLAN_VAP_SECURITY_WPA", "password": "mypasswd", "qosSettings": "WLAN_QOS_BEST_EFFORT", "visibility": true }, "ssidConfigList": [ { "ssid": "myssid1", "visibility": true, "securityAuthType": "WLAN_VAP_SECURITY_NONE", "encryptionKey": "", "encryptionType": "cipherAES", "qosSettings": "WLAN_QOS_VIDEO" }, { "ssid": "myssid2", "visibility": true, "securityAuthType": "WLAN_VAP_SECURITY_WPA", "wpaEncryptionMode": "WPA1", "encryptionKey": "B1C2DE1", "encryptionType": "cipherAES", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid3", "visibility": true, "securityAuthType": "WLAN_VAP_SECURITY_WPA", "wpaEncryptionMode": "WPA1WPA2", "encryptionKey": "A4B5EA1", "encryptionType": "cipherAES", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid4", "visibility": true, "securityAuthType": "WLAN_VAP_SECURITY_8021X", "wpaEncryptionMode": "WPA2", "encryptionKey": "", "encryptionType": "cipherAES", "qosSettings": "WLAN_QOS_BEST_EFFORT", "radiusServer": [ { "host": "1.2.3.4", "port": 1812, "secret": "secret1" }, { "host": "5.6.7.8", "port": 1814, "secret": "secret2" } ] } ], "guestWifi": { "ssid": "Guest123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60" }, "corporateWifi": { "ssid": "Corporate123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60", "corporateWlan": true }, "advancedRadioSetting": { "countryRegionSettings": { "countryRegion": "United State", "regulatoryDomain": "REG_DOMAIN_A" }, "channelPowerSettings": { "radioBand2Dot4Ghz": { "band": "RADIO_2_DOT_4_GHZ", "channel": 11, "transmitPower": 1, "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" }, "radioBand5Ghz": { "band": "RADIO_5_GHZ", "channel": 11, "transmitPower": 1, "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" } } }, "variables": null, "lastUpdatedBy": null, "lastUpdatedOn": null, "createdBy": null, "createdOn": null, "type": "wifi" } }, { "parcelId": "ef215fe9-af7f-4fa1-83c5-0d1e281749a0", "parcelType": "wifi", "createdBy": "admin", "lastUpdatedBy": "admin", "createdOn": 1628716782903, "lastUpdatedOn": 1628716782903, "payload": { "id": null, "name": null, "ssid0": { "ssid": "myWIFI", "security": "WLAN_VAP_SECURITY_WPA", "password": "mypasswd", "qosSettings": "WLAN_QOS_BEST_EFFORT", "visibility": true }, "ssidConfigList": [ { "ssid": "myssid1", "visibility": true, "securityAuthType": "WLAN_VAP_SECURITY_NONE", "encryptionKey": "", "encryptionType": "cipherAES", "qosSettings": "WLAN_QOS_VIDEO" }, { "ssid": "myssid2", "visibility": true, "securityAuthType": "WLAN_VAP_SECURITY_WPA", "wpaEncryptionMode": "WPA1", "encryptionKey": "B1C2DE1", "encryptionType": "cipherAES", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid3", "visibility": true, "securityAuthType": "WLAN_VAP_SECURITY_WPA", "wpaEncryptionMode": "WPA1WPA2", "encryptionKey": "A4B5EA1", "encryptionType": "cipherAES", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid4", "visibility": true, "securityAuthType": "WLAN_VAP_SECURITY_8021X", "wpaEncryptionMode": "WPA2", "encryptionKey": "", "encryptionType": "cipherAES", "qosSettings": "WLAN_QOS_BEST_EFFORT", "radiusServer": [ { "host": "1.2.3.4", "port": 1812, "secret": "secret1" }, { "host": "5.6.7.8", "port": 1814, "secret": "secret2" } ] } ], "guestWifi": { "ssid": "Guest123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60" }, "corporateWifi": { "ssid": "Corporate123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60", "corporateWlan": true }, "advancedRadioSetting": { "countryRegionSettings": { "countryRegion": "United State", "regulatoryDomain": "REG_DOMAIN_A" }, "channelPowerSettings": { "radioBand2Dot4Ghz": { "band": "RADIO_2_DOT_4_GHZ", "channel": 11, "transmitPower": 1, "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" }, "radioBand5Ghz": { "band": "RADIO_5_GHZ", "channel": 11, "transmitPower": 1, "channelWidth": "RADIO_CHANNEL_WIDTH_AUTO" } } }, "variables": null, "lastUpdatedBy": null, "lastUpdatedOn": null, "createdBy": null, "createdOn": null, "type": "wifi" } } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Wifi-read" }, "post": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Create an Wifi Profile Parcel for Mobility feature profile", "operationId": "CreateWifiProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "Wifi Profile Parcel", "content": { "application/json": { "schema": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "ssidConfigList": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "qosSettings": { "pattern": "(WLAN_QOS_BEST_EFFORT|WLAN_QOS_VIDEO|WLAN_QOS_VOICE|WLAN_QOS_BACKGROUND|WLAN_QOS_RESERVED)", "type": "string" }, "securityAuthType": { "pattern": "(OPEN|WPA2-PSK_AES)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/SSIDConfig" } }, "guestWifi": { "type": "object", "properties": { "securityAuthType": { "pattern": "(OPEN|WPA2-PSK_AES)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/GuestWifi" }, "corporateWifi": { "required": [ "securityAuthType" ], "type": "object", "properties": { "aaaServerInfo": { "required": [ "aaaServersParcelId", "radiusServerName" ], "type": "object", "properties": { "aaaServersParcelId": { "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" }, "radiusServerName": { "type": "string" } }, "$$ref": "#/components/schemas/AaaServerInfo" }, "corporateWlan": { "type": "boolean" }, "radiusServer": { "required": [ "host", "port", "secret" ], "type": "object", "properties": { "host": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "port": { "minimum": 0, "type": "integer", "format": "int32" }, "secret": { "type": "string" } }, "$$ref": "#/components/schemas/RadiusServer" }, "securityAuthType": { "pattern": "(WPA2-PSK_AES|WPA2-Enterprise)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/CorporateWifi" }, "advancedRadioSetting": { "type": "object", "properties": { "channelPowerSettings": { "type": "object", "properties": { "radioBand2Dot4Ghz": { "type": "object", "properties": { "band": { "pattern": "(RADIO_2_DOT_4_GHZ)", "type": "string" }, "channel": { "pattern": "(auto|1|2|3|4|5|6|7|8|9|10|11)", "type": "string" }, "channelWidth": { "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ)", "type": "string" }, "transmitPower": { "pattern": "(auto|1|2|3|4|5|6|7)", "type": "string" } }, "$$ref": "#/components/schemas/RadioBandSetting_2_4G" }, "radioBand5Ghz": { "type": "object", "properties": { "band": { "pattern": "(RADIO_5_GHZ)", "type": "string" }, "channel": { "pattern": "(auto|36|40|44|48|52|56|60|64|100|104|108|112|116|120|124|128|132|136|140|144|149|153|157|161|165)", "type": "string" }, "channelWidth": { "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ|RADIO_CHANNEL_WIDTH_40_MHZ|RADIO_CHANNEL_WIDTH_80_MHZ)", "type": "string" }, "transmitPower": { "pattern": "(auto|1|2|3|4|5|6|7)", "type": "string" } }, "$$ref": "#/components/schemas/RadioBandSetting_5G" } }, "$$ref": "#/components/schemas/ChannelPowerSettings" }, "countryRegionSettings": { "type": "object", "properties": { "countryRegion": { "type": "string" }, "regulatoryDomain": { "pattern": "(REG_DOMAIN_INVALID|REG_DOMAIN_A|REG_DOMAIN_B|REG_DOMAIN_C|REG_DOMAIN_D|REG_DOMAIN_E|REG_DOMAIN_F|REG_DOMAIN_G|REG_DOMAIN_H|REG_DOMAIN_I|REG_DOMAIN_J|REG_DOMAIN_K|REG_DOMAIN_L|REG_DOMAIN_M|REG_DOMAIN_N|REG_DOMAIN_P|REG_DOMAIN_Q|REG_DOMAIN_R|REG_DOMAIN_S|REG_DOMAIN_T|REG_DOMAIN_U|REG_DOMAIN_Z|REG_DOMAIN_NONE|REG_DOMAIN_ZZ)", "type": "string" } }, "$$ref": "#/components/schemas/CountryRegionSettings" } }, "$$ref": "#/components/schemas/AdvancedRadioSetting" } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/Wifi" }, "examples": { "Wifi Profile Parcel For Mobility Global Feature Profile": { "description": "Wifi Profile Parcel For Mobility Global Feature Profile", "value": { "name": "config_grp_test", "description": "config_grp_test", "family": "aon", "featureprofiles": [ { "profileName": "config_grp_test_aon", "description": "", "profileType": "aon", "parcels": [ { "ssidConfigList": [ { "ssid": "myssid1", "visibility": true, "securityAuthType": "OPEN", "wpaPskKey": "", "qosSettings": "WLAN_QOS_VIDEO" }, { "ssid": "myssid2", "visibility": true, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "B1C2DE1", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid3", "visibility": true, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A4B5EA1", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid4", "visibility": true, "securityAuthType": "WPA2-Enterprise", "wpaPskKey": "", "qosSettings": "WLAN_QOS_BEST_EFFORT", "radiusServer": [ { "host": "1.2.3.4", "port": 1812, "secret": "secret1" }, { "host": "5.6.7.8", "port": 1814, "secret": "secret2" } ] } ], "guestWifi": { "ssid": "Guest123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60" }, "corporateWifi": { "ssid": "Corporate123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60", "corporateWlan": true }, "advancedRadioSetting": { "countryRegionSettings": { "countryRegion": "United State", "regulatoryDomain": "REG_DOMAIN_A" }, "channelPowerSettings": { "radioBand2Dot4Ghz": { "band": "RADIO_2_DOT_4_GHZ", "channel": "11", "transmitPower": "1", "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" }, "radioBand5Ghz": { "band": "RADIO_5_GHZ", "channel": "36", "transmitPower": "1", "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" } } }, "parcelType": "wifi", "subparcels": [] } ] } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "post response example": { "description": "post response example", "value": { "parcelId": "24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Wifi-write" } }, "/v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId}": { "put": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Edit an Wifi Profile Parcel for Mobility feature profile", "operationId": "EditWifiProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "wifiId", "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": "Wifi Profile Parcel", "content": { "application/json": { "schema": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "ssidConfigList": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "qosSettings": { "pattern": "(WLAN_QOS_BEST_EFFORT|WLAN_QOS_VIDEO|WLAN_QOS_VOICE|WLAN_QOS_BACKGROUND|WLAN_QOS_RESERVED)", "type": "string" }, "securityAuthType": { "pattern": "(OPEN|WPA2-PSK_AES)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/SSIDConfig" } }, "guestWifi": { "type": "object", "properties": { "securityAuthType": { "pattern": "(OPEN|WPA2-PSK_AES)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/GuestWifi" }, "corporateWifi": { "required": [ "securityAuthType" ], "type": "object", "properties": { "aaaServerInfo": { "required": [ "aaaServersParcelId", "radiusServerName" ], "type": "object", "properties": { "aaaServersParcelId": { "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" }, "radiusServerName": { "type": "string" } }, "$$ref": "#/components/schemas/AaaServerInfo" }, "corporateWlan": { "type": "boolean" }, "radiusServer": { "required": [ "host", "port", "secret" ], "type": "object", "properties": { "host": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "port": { "minimum": 0, "type": "integer", "format": "int32" }, "secret": { "type": "string" } }, "$$ref": "#/components/schemas/RadiusServer" }, "securityAuthType": { "pattern": "(WPA2-PSK_AES|WPA2-Enterprise)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/CorporateWifi" }, "advancedRadioSetting": { "type": "object", "properties": { "channelPowerSettings": { "type": "object", "properties": { "radioBand2Dot4Ghz": { "type": "object", "properties": { "band": { "pattern": "(RADIO_2_DOT_4_GHZ)", "type": "string" }, "channel": { "pattern": "(auto|1|2|3|4|5|6|7|8|9|10|11)", "type": "string" }, "channelWidth": { "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ)", "type": "string" }, "transmitPower": { "pattern": "(auto|1|2|3|4|5|6|7)", "type": "string" } }, "$$ref": "#/components/schemas/RadioBandSetting_2_4G" }, "radioBand5Ghz": { "type": "object", "properties": { "band": { "pattern": "(RADIO_5_GHZ)", "type": "string" }, "channel": { "pattern": "(auto|36|40|44|48|52|56|60|64|100|104|108|112|116|120|124|128|132|136|140|144|149|153|157|161|165)", "type": "string" }, "channelWidth": { "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ|RADIO_CHANNEL_WIDTH_40_MHZ|RADIO_CHANNEL_WIDTH_80_MHZ)", "type": "string" }, "transmitPower": { "pattern": "(auto|1|2|3|4|5|6|7)", "type": "string" } }, "$$ref": "#/components/schemas/RadioBandSetting_5G" } }, "$$ref": "#/components/schemas/ChannelPowerSettings" }, "countryRegionSettings": { "type": "object", "properties": { "countryRegion": { "type": "string" }, "regulatoryDomain": { "pattern": "(REG_DOMAIN_INVALID|REG_DOMAIN_A|REG_DOMAIN_B|REG_DOMAIN_C|REG_DOMAIN_D|REG_DOMAIN_E|REG_DOMAIN_F|REG_DOMAIN_G|REG_DOMAIN_H|REG_DOMAIN_I|REG_DOMAIN_J|REG_DOMAIN_K|REG_DOMAIN_L|REG_DOMAIN_M|REG_DOMAIN_N|REG_DOMAIN_P|REG_DOMAIN_Q|REG_DOMAIN_R|REG_DOMAIN_S|REG_DOMAIN_T|REG_DOMAIN_U|REG_DOMAIN_Z|REG_DOMAIN_NONE|REG_DOMAIN_ZZ)", "type": "string" } }, "$$ref": "#/components/schemas/CountryRegionSettings" } }, "$$ref": "#/components/schemas/AdvancedRadioSetting" } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/Wifi" }, "examples": { "Wifi Profile Parcel For Mobility Global Feature Profile": { "description": "Wifi Profile Parcel For Mobility Global Feature Profile", "value": { "name": "config_grp_test", "description": "config_grp_test", "family": "aon", "featureprofiles": [ { "profileName": "config_grp_test_aon", "description": "", "profileType": "aon", "parcels": [ { "ssidConfigList": [ { "ssid": "myssid1", "visibility": true, "securityAuthType": "OPEN", "wpaPskKey": "", "qosSettings": "WLAN_QOS_VIDEO" }, { "ssid": "myssid2", "visibility": true, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "B1C2DE1", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid3", "visibility": true, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A4B5EA1", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid4", "visibility": true, "securityAuthType": "WPA2-Enterprise", "wpaPskKey": "", "qosSettings": "WLAN_QOS_BEST_EFFORT", "radiusServer": [ { "host": "1.2.3.4", "port": 1812, "secret": "secret1" }, { "host": "5.6.7.8", "port": 1814, "secret": "secret2" } ] } ], "guestWifi": { "ssid": "Guest123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60" }, "corporateWifi": { "ssid": "Corporate123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60", "corporateWlan": true }, "advancedRadioSetting": { "countryRegionSettings": { "countryRegion": "United State", "regulatoryDomain": "REG_DOMAIN_A" }, "channelPowerSettings": { "radioBand2Dot4Ghz": { "band": "RADIO_2_DOT_4_GHZ", "channel": "11", "transmitPower": "1", "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" }, "radioBand5Ghz": { "band": "RADIO_5_GHZ", "channel": "36", "transmitPower": "1", "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" } } }, "parcelType": "wifi", "subparcels": [] } ] } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Wifi-write" }, "get": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Get an Wifi Profile Parcel for Mobility feature profile", "operationId": "GetWifiProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "wifiId", "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": { "discriminator": { "propertyName": "type" }, "properties": { "createdBy": { "type": "string", "description": "User who last created this.", "readOnly": true }, "createdOn": { "type": "integer", "description": "Timestamp of creation", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Description of the Profile Parcel.", "example": "Wifi 7 profile Parcel" }, "id": { "type": "string", "description": "System generated unique identifier of the Profile Parcel in UUID format.", "example": "6fa14197-c25f-4a14-b81b-299de32ed2ca" }, "lastUpdatedBy": { "type": "string", "description": "User who last updated this.", "readOnly": true }, "lastUpdatedOn": { "type": "integer", "description": "Timestamp of last update", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Name of the Profile Parcel. Must be unique.", "example": "Wifi profile Parcel" }, "type": { "type": "string", "description": "type", "example": "wifi", "enum": [ "cellular", "wifi", "ethernet", "globalSettings", "networkProtocol", "securityPolicy" ] }, "variables": { "type": "array", "items": { "required": [ "jsonPath", "varName" ], "type": "object", "properties": { "jsonPath": { "type": "string" }, "varName": { "type": "string" } }, "$$ref": "#/components/schemas/Variable" } }, "ssidConfigList": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "qosSettings": { "pattern": "(WLAN_QOS_BEST_EFFORT|WLAN_QOS_VIDEO|WLAN_QOS_VOICE|WLAN_QOS_BACKGROUND|WLAN_QOS_RESERVED)", "type": "string" }, "securityAuthType": { "pattern": "(OPEN|WPA2-PSK_AES)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/SSIDConfig" } }, "guestWifi": { "type": "object", "properties": { "securityAuthType": { "pattern": "(OPEN|WPA2-PSK_AES)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/GuestWifi" }, "corporateWifi": { "required": [ "securityAuthType" ], "type": "object", "properties": { "aaaServerInfo": { "required": [ "aaaServersParcelId", "radiusServerName" ], "type": "object", "properties": { "aaaServersParcelId": { "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" }, "radiusServerName": { "type": "string" } }, "$$ref": "#/components/schemas/AaaServerInfo" }, "corporateWlan": { "type": "boolean" }, "radiusServer": { "required": [ "host", "port", "secret" ], "type": "object", "properties": { "host": { "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])(%[\\p{N}\\p{L}]+)?", "type": "string" }, "port": { "minimum": 0, "type": "integer", "format": "int32" }, "secret": { "type": "string" } }, "$$ref": "#/components/schemas/RadiusServer" }, "securityAuthType": { "pattern": "(WPA2-PSK_AES|WPA2-Enterprise)", "type": "string" }, "ssid": { "maxLength": 32, "minLength": 1, "type": "string" }, "visibility": { "type": "boolean" }, "wpaPskKey": { "type": "string" } }, "$$ref": "#/components/schemas/CorporateWifi" }, "advancedRadioSetting": { "type": "object", "properties": { "channelPowerSettings": { "type": "object", "properties": { "radioBand2Dot4Ghz": { "type": "object", "properties": { "band": { "pattern": "(RADIO_2_DOT_4_GHZ)", "type": "string" }, "channel": { "pattern": "(auto|1|2|3|4|5|6|7|8|9|10|11)", "type": "string" }, "channelWidth": { "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ)", "type": "string" }, "transmitPower": { "pattern": "(auto|1|2|3|4|5|6|7)", "type": "string" } }, "$$ref": "#/components/schemas/RadioBandSetting_2_4G" }, "radioBand5Ghz": { "type": "object", "properties": { "band": { "pattern": "(RADIO_5_GHZ)", "type": "string" }, "channel": { "pattern": "(auto|36|40|44|48|52|56|60|64|100|104|108|112|116|120|124|128|132|136|140|144|149|153|157|161|165)", "type": "string" }, "channelWidth": { "pattern": "(RADIO_CHANNEL_WIDTH_20_MHZ|RADIO_CHANNEL_WIDTH_40_MHZ|RADIO_CHANNEL_WIDTH_80_MHZ)", "type": "string" }, "transmitPower": { "pattern": "(auto|1|2|3|4|5|6|7)", "type": "string" } }, "$$ref": "#/components/schemas/RadioBandSetting_5G" } }, "$$ref": "#/components/schemas/ChannelPowerSettings" }, "countryRegionSettings": { "type": "object", "properties": { "countryRegion": { "type": "string" }, "regulatoryDomain": { "pattern": "(REG_DOMAIN_INVALID|REG_DOMAIN_A|REG_DOMAIN_B|REG_DOMAIN_C|REG_DOMAIN_D|REG_DOMAIN_E|REG_DOMAIN_F|REG_DOMAIN_G|REG_DOMAIN_H|REG_DOMAIN_I|REG_DOMAIN_J|REG_DOMAIN_K|REG_DOMAIN_L|REG_DOMAIN_M|REG_DOMAIN_N|REG_DOMAIN_P|REG_DOMAIN_Q|REG_DOMAIN_R|REG_DOMAIN_S|REG_DOMAIN_T|REG_DOMAIN_U|REG_DOMAIN_Z|REG_DOMAIN_NONE|REG_DOMAIN_ZZ)", "type": "string" } }, "$$ref": "#/components/schemas/CountryRegionSettings" } }, "$$ref": "#/components/schemas/AdvancedRadioSetting" } }, "required": [ "name", "type", "name", "type" ], "type": "object", "$$ref": "#/components/schemas/Wifi" } }, "$$ref": "#/components/schemas/getSingleMobilityGlobalWifiPayload" }, "examples": { "Wifi Profile Parcel For Mobility Global Feature Profile": { "description": "Wifi Profile Parcel For Mobility Global Feature Profile", "value": { "name": "config_grp_test", "description": "config_grp_test", "family": "aon", "featureprofiles": [ { "profileName": "config_grp_test_aon", "description": "", "profileType": "aon", "parcels": [ { "ssidConfigList": [ { "ssid": "myssid1", "visibility": true, "securityAuthType": "OPEN", "wpaPskKey": "", "qosSettings": "WLAN_QOS_VIDEO" }, { "ssid": "myssid2", "visibility": true, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "B1C2DE1", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid3", "visibility": true, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A4B5EA1", "qosSettings": "WLAN_QOS_BEST_EFFORT" }, { "ssid": "myssid4", "visibility": true, "securityAuthType": "WPA2-Enterprise", "wpaPskKey": "", "qosSettings": "WLAN_QOS_BEST_EFFORT", "radiusServer": [ { "host": "1.2.3.4", "port": 1812, "secret": "secret1" }, { "host": "5.6.7.8", "port": 1814, "secret": "secret2" } ] } ], "guestWifi": { "ssid": "Guest123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60" }, "corporateWifi": { "ssid": "Corporate123", "visibility": false, "securityAuthType": "WPA2-PSK_AES", "wpaPskKey": "A2BC3ED", "encryptionType": "cipherAES", "wpaEncryptionMode": "WPA2", "validityPeriod": "60", "corporateWlan": true }, "advancedRadioSetting": { "countryRegionSettings": { "countryRegion": "United State", "regulatoryDomain": "REG_DOMAIN_A" }, "channelPowerSettings": { "radioBand2Dot4Ghz": { "band": "RADIO_2_DOT_4_GHZ", "channel": "11", "transmitPower": "1", "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" }, "radioBand5Ghz": { "band": "RADIO_5_GHZ", "channel": "36", "transmitPower": "1", "channelWidth": "RADIO_CHANNEL_WIDTH_20_MHZ" } } }, "parcelType": "wifi", "subparcels": [] } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Feature Profile > Teleworker > Wifi-read" }, "delete": { "tags": [ "Configuration - Feature Profile (Mobility)" ], "description": "Delete an Wifi Profile Parcel for Mobility feature profile", "operationId": "DeleteWifiProfileParcelForMobility", "parameters": [ { "name": "profileId", "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": "wifiId", "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 > Teleworker > Wifi-write" } }, "/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\u00a0 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\u00a0 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\u00a0 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" } } } }