openapi: 3.2.0 info: title: Feature Profiles - Mobility and NFV Configuration - Feature Profile (Mobility) API description: "Feature profiles associated with UX 2.0 configuration\nIncludes API operations for the following:\n Feature Profiles in Mobility and NFV Solutions\n Supporting mobility features and Network Function Virtualization (NFV) configurations." contact: email: vmanage@cisco.com license: name: Commercial License url: https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html version: 26.1.0+2026-01-06 x-provenance: method: harvested authored_by: Cisco Catalyst SD-WAN harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true provider_published: true source_host: pubhub.devnetcloud.com note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host. x-evidence: - type: source url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/ - type: source url: https://developer.cisco.com/docs/sdwan/ servers: - url: /dataservice tags: - name: Configuration - Feature Profile (Mobility) 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 gw-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 gw-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 gw-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 gw-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