Virtual Server Profile¶
Overview¶
This document describes the API to configure Virtual Server Profiles and their properties in BIG-IQ.
REST Endpoint: /mgmt/cm/access/working-config/ltm/virtual/*/profiles¶
Requests¶
GET /mgmt/cm/access/working-config/ltm/virtual/<id>/profiles/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
accessProfileReference | reference | Specifies the profile for managing secure access. The default is None. Create access profile and associate it to the name property in the reference. Note: APM supports assigning only one of these profiles to a virtual server: an access profile or a PingAcess profile. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
enableRbaPlugin | boolean | If we specifies access profile to the virtual server, before creating access profile, Enable RBA Plugin needs to be created. |
enableWebSsoPlugin | boolean | If we specifies access profile to the virtual server, before creating access profile, Enable Web SSO Plugin needs to be created. |
connectivityProfileReference | reference | Specifies the profile for managing specific connection options for a secure access connection. The default is None. Create connectivity profile and associate it to the name property in the reference. You cannot select the default profile, connectivity, from this list. You must have configured at least one connectivity profile before you can specify a connectivity profile for a network access connection. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
enablePppProfile | boolean | If we specifies connectivity profile to the virtual server, before creating connectivity profile, Enable PPP profile needs to be created. |
vdiProfileReference | reference | Specifies a VDI profile for use when you want to provide connections to virtual desktop resources. The default is None. Create VDI profile and associate it to the name property in the reference. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
pingAccessProfileReference | reference | Specifies an already configured PingAccess Profile for authentication with a PingAccess policy server. The default is None. Note: APM supports assigning only one of these profiles to a virtual server: an access profile or a PingAccess profile. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
remoteDesktopProfileReference | reference | Specify to support connections from Java applications or to support a SOCKS tunnel from an iOS mobile device that initiates per-app VPN. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
rewriteProfilePath | string | Specify rewrite profile to rewrite web application data or to perform URI translation with the reverse proxy. |
context | string | Virtual Server Context for client side or sever side or both. For access value is always ‘all’ |
kind | string | The kind of an application. |
selfLink | string | The selfLink of an application. |
Error Response¶
HTTP/1.1 400 Bad Request
This response status is related to error conditions. A detailed error message displays in the response.
HTTP/1.1 401 Unauthorized
This response happens when access is denied due to invalid credentials(no Permission).
Permissions¶
Role | Allow |
---|---|
Application_Editor | Yes |
Service_Catalog_Viewer | Yes |
Service_Catalog_Editor | Yes |
Trust_Discovery_Import | Yes |
Access_View | Yes |
Access_Edit | Yes |
Access_Manager | Yes |
Application_Manager | Yes |
Application_Viewer | Yes |
Access_Deploy | Yes |
Access_Policy_Editor | Yes |
POST /mgmt/cm/access/working-config/ltm/virtual/<id>/profiles/¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
accessProfileReference | reference | False | Specifies the profile for managing secure access. The default is None. Create access profile and associate it to the name property in the reference. Note: APM supports assigning only one of these profiles to a virtual server: an access profile or a PingAcess profile. |
link | string | True | URI link of the reference. |
enableRbaPlugin | boolean | False | If we specifies access profile to the virtual server, before creating access profile, Enable RBA Plugin needs to be created. |
enableWebSsoPlugin | boolean | False | If we specifies access profile to the virtual server, before creating access profile, Enable Web SSO Plugin needs to be created. |
connectivityProfileReference | reference | False | Specifies the profile for managing specific connection options for a secure access connection. The default is None. Create connectivity profile and associate it to the name property in the reference. You cannot select the default profile, connectivity, from this list. You must have configured at least one connectivity profile before you can specify a connectivity profile for a network access connection. |
link | string | True | URI link of the reference. |
enablePppProfile | boolean | False | If we specifies connectivity profile to the virtual server, before creating connectivity profile, Enable PPP profile needs to be created. |
vdiProfileReference | reference | False | Specifies a VDI profile for use when you want to provide connections to virtual desktop resources. The default is None. Create VDI profile and associate it to the name property in the reference. |
link | string | True | URI link of the reference. |
pingAccessProfileReference | reference | False | Specifies an already configured PingAccess Profile for authentication with a PingAccess policy server. The default is None. Note: APM supports assigning only one of these profiles to a virtual server: an access profile or a PingAccess profile. |
link | string | True | URI link of the reference. |
remoteDesktopProfileReference | reference | False | Specify to support connections from Java applications or to support a SOCKS tunnel from an iOS mobile device that initiates per-app VPN. |
link | string | True | URI link of the reference. |
rewriteProfilePath | string | False | Specify rewrite profile to rewrite web application data or to perform URI translation with the reverse proxy. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
accessProfileReference | reference | Specifies the profile for managing secure access. The default is None. Create access profile and associate it to the name property in the reference. Note: APM supports assigning only one of these profiles to a virtual server: an access profile or a PingAcess profile. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
enableRbaPlugin | boolean | If we specifies access profile to the virtual server, before creating access profile, Enable RBA Plugin needs to be created. |
enableWebSsoPlugin | boolean | If we specifies access profile to the virtual server, before creating access profile, Enable Web SSO Plugin needs to be created. |
connectivityProfileReference | reference | Specifies the profile for managing specific connection options for a secure access connection. The default is None. Create connectivity profile and associate it to the name property in the reference. You cannot select the default profile, connectivity, from this list. You must have configured at least one connectivity profile before you can specify a connectivity profile for a network access connection. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
enablePppProfile | boolean | If we specifies connectivity profile to the virtual server, before creating connectivity profile, Enable PPP profile needs to be created. |
vdiProfileReference | reference | Specifies a VDI profile for use when you want to provide connections to virtual desktop resources. The default is None. Create VDI profile and associate it to the name property in the reference. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
pingAccessProfileReference | reference | Specifies an already configured PingAccess Profile for authentication with a PingAccess policy server. The default is None. Note: APM supports assigning only one of these profiles to a virtual server: an access profile or a PingAccess profile. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
remoteDesktopProfileReference | reference | Specify to support connections from Java applications or to support a SOCKS tunnel from an iOS mobile device that initiates per-app VPN. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
rewriteProfilePath | string | Specify rewrite profile to rewrite web application data or to perform URI translation with the reverse proxy. |
context | string | Virtual Server Context for client side or sever side or both. For access value is always ‘all’ |
kind | string | The kind of an application. |
selfLink | string | The selfLink of an application. |
Error Response¶
HTTP/1.1 400 Bad Request
This response status is related to error conditions. A detailed error message displays in the response.
HTTP/1.1 401 Unauthorized
This response happens when access is denied due to invalid credentials(no Permission).
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
Service_Catalog_Viewer | No |
Service_Catalog_Editor | No |
Trust_Discovery_Import | No |
Access_View | No |
Access_Edit | Yes |
Access_Manager | Yes |
Application_Manager | No |
Application_Viewer | No |
Access_Deploy | No |
Access_Policy_Editor | No |
DELETE /mgmt/cm/access/working-config/ltm/virtual/<id>/profiles/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
accessProfileReference | reference | Specifies the profile for managing secure access. The default is None. Create access profile and associate it to the name property in the reference. Note: APM supports assigning only one of these profiles to a virtual server: an access profile or a PingAcess profile. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
enableRbaPlugin | boolean | If we specifies access profile to the virtual server, before creating access profile, Enable RBA Plugin needs to be created. |
enableWebSsoPlugin | boolean | If we specifies access profile to the virtual server, before creating access profile, Enable Web SSO Plugin needs to be created. |
connectivityProfileReference | reference | Specifies the profile for managing specific connection options for a secure access connection. The default is None. Create connectivity profile and associate it to the name property in the reference. You cannot select the default profile, connectivity, from this list. You must have configured at least one connectivity profile before you can specify a connectivity profile for a network access connection. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
enablePppProfile | boolean | If we specifies connectivity profile to the virtual server, before creating connectivity profile, Enable PPP profile needs to be created. |
vdiProfileReference | reference | Specifies a VDI profile for use when you want to provide connections to virtual desktop resources. The default is None. Create VDI profile and associate it to the name property in the reference. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
pingAccessProfileReference | reference | Specifies an already configured PingAccess Profile for authentication with a PingAccess policy server. The default is None. Note: APM supports assigning only one of these profiles to a virtual server: an access profile or a PingAccess profile. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
remoteDesktopProfileReference | reference | Specify to support connections from Java applications or to support a SOCKS tunnel from an iOS mobile device that initiates per-app VPN. |
name | string | Name of the resource |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
rewriteProfilePath | string | Specify rewrite profile to rewrite web application data or to perform URI translation with the reverse proxy. |
context | string | Virtual Server Context for client side or sever side or both. For access value is always ‘all’ |
kind | string | The kind of an application. |
selfLink | string | The selfLink of an application. |
Error Response¶
HTTP/1.1 400 Bad Request
This response status is related to error conditions. A detailed error message displays in the response.
HTTP/1.1 401 Unauthorized
This response happens when access is denied due to invalid credentials(no Permission).
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
Service_Catalog_Viewer | No |
Service_Catalog_Editor | No |
Trust_Discovery_Import | No |
Access_View | No |
Access_Edit | Yes |
Access_Manager | Yes |
Application_Manager | No |
Application_Viewer | No |
Access_Deploy | No |
Access_Policy_Editor | No |
Examples¶
Get Virtual Server¶
GET /mgmt/cm/access/working-config/ltm/virtual/<id>/profiles/<id>
Response¶
HTTP/1.1 200 OK
{
"accessProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enableRbaPlugin": false,
"enableWebSsoPlugin": false,
"connectivityProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enablePppProfile": false,
"vdiProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"pingAccessProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"remoteDesktopProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"rewriteProfilePath": "none",
"context": "all",
}
Create Virtual Server¶
POST /mgmt/cm/access/working-config/ltm/virtual/<id>/profiles/
{
"accessProfileReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enableRbaPlugin": false,
"enableWebSsoPlugin": false,
"connectivityProfileReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enablePppProfile": false,
"vdiProfileReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"pingAccessProfileReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"remoteDesktopProfileReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"rewriteProfilePath": "none",
}
Response¶
HTTP/1.1 200 OK
{
"accessProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enableRbaPlugin": false,
"enableWebSsoPlugin": false,
"connectivityProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enablePppProfile": false,
"vdiProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"pingAccessProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"remoteDesktopProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"rewriteProfilePath": "none",
"context": "all",
}
Delete Virtual Server Profile¶
DELETE /mgmt/cm/access/working-config/ltm/virtual/<id>/profiles/<id>
Response¶
HTTP/1.1 200 OK
{
"accessProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enableRbaPlugin": false,
"enableWebSsoPlugin": false,
"connectivityProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"enablePppProfile": false,
"vdiProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"pingAccessProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"remoteDesktopProfileReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"rewriteProfilePath": "none",
"context": "all",
"kind": "cm:access:working-config:apm:aaa:state",
"selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
}