Virtual Server¶
Overview¶
This document describes the API to configure virtual servers and their properties in BIG-IQ.
REST Endpoint: /cm/access/working-config/ltm/virtual¶
Requests¶
GET /cm/access/working-config/ltm/virtual/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
ipProtocol | string | Specifies a network protocol name you want the system to use to direct traffic on this virtual server. For Access profiles and policies, the value is always ‘tcp’. |
profilesReference | reference | Reference of the Access profile which is selected. |
link | string | URI link of the reference. |
perFlowRequestAccessPolicyReference | reference | Reference of the Per Request Policy which is selected. |
name | string | Name of the resource. |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
name | string | The name of the object. |
partition | string | The BIG-IP partition where the object should be placed. |
subPath | string | The BIG-IP folder where the object should be placed. |
description | string | An ID of an application. |
id | string | An ID of the application. |
kind | string | The kind of application. |
selfLink | string | The selfLink of an application. |
deviceReference | reference | Reference to the device. |
id | string | Id of the device. |
name | string | Device name. Typically it is device’s hostname. |
kind | string | Kind of the device. |
machineId | string | Machine ID of the device. |
link | string | URI link of the reference. |
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 |
PUT /cm/access/working-config/ltm/virtual/<id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
ipProtocol | string | False | Specifies a network protocol name you want the system to use to direct traffic on this virtual server. For Access profiles and policies, the value is always ‘tcp’. |
profilesReference | reference | False | Reference of the Access profile which is selected. |
link | string | True | URI link of the reference. |
perFlowRequestAccessPolicyReference | reference | False | Reference of the Per Request Policy which is selected. |
name | string | True | Name of the resource. |
kind | string | True | The kind of the resource. |
link | string | True | URI link of the reference. |
name | string | True | The name of the object. |
partition | string | True | The BIG-IP partition where the object should be placed. |
subPath | string | False | The BIG-IP folder where the object should be placed. |
description | string | False | The description of an application |
id | string | An ID of the application. | |
kind | string | False | The kind of application. |
selfLink | string | False | The selfLink of an application. |
deviceReference | reference | False | Reference to the device. |
id | string | False | Id of the device. |
name | string | False | Device name. Typically it is device’s hostname. |
kind | string | False | Kind of the device. |
machineId | string | False | Machine ID of the device. |
link | string | False | URI link of the reference. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
ipProtocol | string | Specifies a network protocol name you want the system to use to direct traffic on this virtual server. For Access profiles and policies, the value is always ‘tcp’. |
profilesReference | reference | Reference of the Access profile which is selected. |
link | string | URI link of the reference. |
perFlowRequestAccessPolicyReference | reference | Reference of the Per Request Policy which is selected. |
name | string | Name of the resource. |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
name | string | The name of the object. |
partition | string | The BIG-IP partition where the object should be placed. |
subPath | string | The BIG-IP folder where the object should be placed. |
description | string | An ID of an application. |
id | string | An ID of the application |
kind | string | The kind of application. |
selfLink | string | The selfLink of an application. |
deviceReference | reference | Reference to the device. |
id | string | Id of the device. |
name | string | Device name. Typically it is device’s hostname. |
kind | string | Kind of the device. |
machineId | string | Machine ID of the device. |
link | string | URI link of the reference. |
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 |
PATCH /cm/access/working-config/ltm/virtual/<id>¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
ipProtocol | string | False | Specifies a network protocol name you want the system to use to direct traffic on this virtual server. For Access profiles and policies, the value is always ‘tcp’. |
profilesReference | reference | False | Reference of the Access profile which is selected. |
link | string | False | URI link of the reference. |
perFlowRequestAccessPolicyReference | reference | False | Reference of the Per Request Policy which is selected. |
link | string | False | URI link of the reference. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
ipProtocol | string | Specifies a network protocol name you want the system to use to direct traffic on this virtual server. For Access profiles and policies, the value is always ‘tcp’. |
profilesReference | reference | Reference of the Access profile which is selected. |
link | string | URI link of the reference. |
perFlowRequestAccessPolicyReference | reference | Reference of the Per Request Policy which is selected. |
name | string | Name of the resource. |
kind | string | The kind of the resource. |
link | string | URI link of the reference. |
name | string | The name of the object. |
partition | string | The BIG-IP partition where the object should be placed. |
subPath | string | The BIG-IP folder where the object should be placed. |
description | string | An ID of an application. |
id | string | An ID of the application. |
kind | string | The kind of application. |
selfLink | string | The selfLink of an application. |
deviceReference | reference | Reference to the device. |
id | string | Id of the device. |
name | string | Device name. Typically it is device’s hostname. |
kind | string | Kind of the device. |
machineId | string | Machine ID of the device. |
link | string | URI link of the reference. |
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 /cm/access/working-config/ltm/virtual/<id>
Response¶
HTTP/1.1 200 OK
{
"ipProtocol": "tcp",
"profilesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"perFlowRequestAccessPolicyReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"name": "foo",
"partition": "Common",
"subPath": "/folder",
"description": "Application configuration details.",
"id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
"kind": "cm:access:working-config:apm:aaa:state",
"selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
"deviceReference": {
"id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
"name": "bigip.foo.com",
"kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
"machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Edit Virtual Server¶
PUT /cm/access/working-config/ltm/virtual/<id>
{
"ipProtocol": "tcp",
"profilesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"perFlowRequestAccessPolicyReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"name": "foo",
"partition": "Common",
"subPath": "/folder",
"description": "Application configuration details.",
"id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
"kind": "cm:access:working-config:apm:aaa:state",
"selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
"deviceReference": {
"id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
"name": "bigip.foo.com",
"kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
"machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Response¶
HTTP/1.1 200 OK
{
"ipProtocol": "tcp",
"profilesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"perFlowRequestAccessPolicyReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"name": "foo",
"partition": "Common",
"subPath": "/folder",
"description": "Application configuration details.",
"id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
"kind": "cm:access:working-config:apm:aaa:state",
"selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
"deviceReference": {
"id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
"name": "bigip.foo.com",
"kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
"machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}
Edit Virtual Server¶
PATCH /cm/access/working-config/ltm/virtual/<id>
{
"ipProtocol": "tcp",
"profilesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"perFlowRequestAccessPolicyReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"description": "Application configuration details."
}
Response¶
HTTP/1.1 200 OK
{
"ipProtocol": "tcp",
"profilesReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"perFlowRequestAccessPolicyReference": {
"name": "resourceName",
"kind": "shared:resolver:device-groups:devicegroupstate",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"name": "foo",
"partition": "Common",
"subPath": "/folder",
"description": "Application configuration details.",
"id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
"kind": "cm:access:working-config:apm:aaa:state",
"selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
"deviceReference": {
"id": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
"name": "bigip.foo.com",
"kind": "shared:resolver:device-groups:restdeviceresolverdevicestate",
"machineId": "866cfd8a-4d03-48e9-ba94-bb21a4bc2346",
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
}
}