Network Access Optimized App Properties

Overview

This document describes the API to configure Network Access Optimized Apps and their properties in BIG-IQ.

REST Endpoint: /mgmt/cm/access/working-config/apm/resource/network-access/*/optimized-app

Requests

GET /mgmt/cm/access/working-config/apm/resource/network-access/<id>/optimized-app/<id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
compressionAdaptive string Specify to automatically select the compression type based on network and traffic characteristics
compressionBzip2 string Specify to Use the most CPU resources but compresses the resources the most effectively.
compressionDeflate string Uses the fewest CPU resources but compresses the resources the least effectively.
compressionLzo string Specify to offer a balance between CPU resources and the compression ratio, compressing more than deflating, but with fewer CPU resources than Bzip2
compressionNull string Compression should be enabled or disabled. The default is enabled.
deflateLevel number Specify the deflate level. Value is always 1.
host string Specify the host name as the optimized application destination.
portRange string Specify a port or a port range.
subnet string Specify the IP Address with the mask as the optimized application destination.
name string The name of the object
id string An ID of an application
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/apm/resource/network-access/<id>/optimized-app/

Request Parameters

Name Type Required Description
compressionAdaptive string False Specify to automatically select the compression type based on network and traffic characteristics
compressionBzip2 string False Specify to Use the most CPU resources but compresses the resources the most effectively.
compressionDeflate string False Uses the fewest CPU resources but compresses the resources the least effectively.
compressionLzo string False Specify to offer a balance between CPU resources and the compression ratio, compressing more than deflating, but with fewer CPU resources than Bzip2
compressionNull string False Compression should be enabled or disabled. The default is enabled.
deflateLevel number False Specify the deflate level. Value is always 1.
host string True Specify the host name as the optimized application destination.
portRange string True Specify a port or a port range.
subnet string True Specify the IP Address with the mask as the optimized application destination.
name string True The name of the object

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
compressionAdaptive string Specify to automatically select the compression type based on network and traffic characteristics
compressionBzip2 string Specify to Use the most CPU resources but compresses the resources the most effectively.
compressionDeflate string Uses the fewest CPU resources but compresses the resources the least effectively.
compressionLzo string Specify to offer a balance between CPU resources and the compression ratio, compressing more than deflating, but with fewer CPU resources than Bzip2
compressionNull string Compression should be enabled or disabled. The default is enabled.
deflateLevel number Specify the deflate level. Value is always 1.
host string Specify the host name as the optimized application destination.
portRange string Specify a port or a port range.
subnet string Specify the IP Address with the mask as the optimized application destination.
name string The name of the object
id string An ID of an application
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

PUT /mgmt/cm/access/working-config/apm/resource/network-access/<id>/optimized-app/<id>

Request Parameters

Name Type Required Description
compressionAdaptive string False Specify to automatically select the compression type based on network and traffic characteristics
compressionBzip2 string False Specify to Use the most CPU resources but compresses the resources the most effectively.
compressionDeflate string False Uses the fewest CPU resources but compresses the resources the least effectively.
compressionLzo string False Specify to offer a balance between CPU resources and the compression ratio, compressing more than deflating, but with fewer CPU resources than Bzip2
compressionNull string False Compression should be enabled or disabled. The default is enabled.
deflateLevel number False Specify the deflate level. Value is always 1.
host string False Specify the host name as the optimized application destination.
portRange string False Specify a port or a port range.
subnet string False Specify the IP Address with the mask as the optimized application destination.
name string False The name of the object
id string False An ID of an application
kind string True The kind of an application.
selfLink string True The selfLink of an application.

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
compressionAdaptive string Specify to automatically select the compression type based on network and traffic characteristics
compressionBzip2 string Specify to Use the most CPU resources but compresses the resources the most effectively.
compressionDeflate string Uses the fewest CPU resources but compresses the resources the least effectively.
compressionLzo string Specify to offer a balance between CPU resources and the compression ratio, compressing more than deflating, but with fewer CPU resources than Bzip2
compressionNull string Compression should be enabled or disabled. The default is enabled.
deflateLevel number Specify the deflate level. Value is always 1.
host string Specify the host name as the optimized application destination.
portRange string Specify a port or a port range.
subnet string Specify the IP Address with the mask as the optimized application destination.
name string The name of the object
id string An ID of an application
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

PATCH /mgmt/cm/access/working-config/apm/resource/network-access/<id>/optimized-app/<id>

Request Parameters

Name Type Required Description
compressionAdaptive string False Specify to automatically select the compression type based on network and traffic characteristics
compressionBzip2 string False Specify to Use the most CPU resources but compresses the resources the most effectively.
compressionDeflate string False Uses the fewest CPU resources but compresses the resources the least effectively.
compressionLzo string False Specify to offer a balance between CPU resources and the compression ratio, compressing more than deflating, but with fewer CPU resources than Bzip2
compressionNull string False Compression should be enabled or disabled. The default is enabled.
deflateLevel number False Specify the deflate level. Value is always 1.
host string True Specify the host name as the optimized application destination.
portRange string True Specify a port or a port range.
subnet string True Specify the IP Address with the mask as the optimized application destination.

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
compressionAdaptive string Specify to automatically select the compression type based on network and traffic characteristics
compressionBzip2 string Specify to Use the most CPU resources but compresses the resources the most effectively.
compressionDeflate string Uses the fewest CPU resources but compresses the resources the least effectively.
compressionLzo string Specify to offer a balance between CPU resources and the compression ratio, compressing more than deflating, but with fewer CPU resources than Bzip2
compressionNull string Compression should be enabled or disabled. The default is enabled.
deflateLevel number Specify the deflate level. Value is always 1.
host string Specify the host name as the optimized application destination.
portRange string Specify a port or a port range.
subnet string Specify the IP Address with the mask as the optimized application destination.
name string The name of the object
id string An ID of an application
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/apm/resource/network-access/<id>/optimized-app/<id>

Request Parameters

None

Query Parameters

None

Response

HTTP/1.1 200 OK

Name Type Description
compressionAdaptive string Specify to automatically select the compression type based on network and traffic characteristics
compressionBzip2 string Specify to Use the most CPU resources but compresses the resources the most effectively.
compressionDeflate string Uses the fewest CPU resources but compresses the resources the least effectively.
compressionLzo string Specify to offer a balance between CPU resources and the compression ratio, compressing more than deflating, but with fewer CPU resources than Bzip2
compressionNull string Compression should be enabled or disabled. The default is enabled.
deflateLevel number Specify the deflate level. Value is always 1.
host string Specify the host name as the optimized application destination.
portRange string Specify a port or a port range.
subnet string Specify the IP Address with the mask as the optimized application destination.
name string The name of the object
id string An ID of an application
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 Network Access Optimized App Properties

GET /mgmt/cm/access/working-config/apm/resource/network-access/<id>/optimized-app/<id>

Response

HTTP/1.1 200 OK
{
    "compressionAdaptive": "true",
    "compressionBzip2": "true",
    "compressionDeflate": "true",
    "compressionLzo": "true",
    "compressionNull": "true",
    "deflateLevel": 1,
    "host": "www.foo.com",
    "portRange": "21",
    "subnet": "1.1.1.1/32",
    "name": "foo",
    "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"
}

Create Network Access Optimized App Properties

POST /mgmt/cm/access/working-config/apm/resource/network-access/<id>/optimized-app/
{
    "compressionAdaptive": "true",
    "compressionBzip2": "true",
    "compressionDeflate": "true",
    "compressionLzo": "true",
    "compressionNull": "true",
    "deflateLevel": 1,
    "host": "www.foo.com",
    "portRange": "21",
    "subnet": "1.1.1.1/32",
    "name": "foo",
}

Response

HTTP/1.1 200 OK
{
    "compressionAdaptive": "true",
    "compressionBzip2": "true",
    "compressionDeflate": "true",
    "compressionLzo": "true",
    "compressionNull": "true",
    "deflateLevel": 1,
    "host": "www.foo.com",
    "portRange": "21",
    "subnet": "1.1.1.1/32",
    "name": "foo",
    "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"
}

Edit Network Access Optimized App Properties

PUT /mgmt/cm/access/working-config/apm/resource/network-access/<id>/optimized-app/<id>
{
    "compressionAdaptive": "true",
    "compressionBzip2": "true",
    "compressionDeflate": "true",
    "compressionLzo": "true",
    "compressionNull": "true",
    "deflateLevel": 1,
    "host": "www.foo.com",
    "portRange": "21",
    "subnet": "1.1.1.1/32",
    "name": "foo",
    "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"
}

Response

HTTP/1.1 200 OK
{
    "compressionAdaptive": "true",
    "compressionBzip2": "true",
    "compressionDeflate": "true",
    "compressionLzo": "true",
    "compressionNull": "true",
    "deflateLevel": 1,
    "host": "www.foo.com",
    "portRange": "21",
    "subnet": "1.1.1.1/32",
    "name": "foo",
    "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"
}

Edit Network Access Optimized App Properties

PATCH /mgmt/cm/access/working-config/apm/resource/network-access/<id>/optimized-app/<id>
{
    "compressionAdaptive": "true",
    "compressionBzip2": "true",
    "compressionDeflate": "true",
    "compressionLzo": "true",
    "compressionNull": "true",
    "deflateLevel": 1,
    "host": "www.foo.com",
    "portRange": "21",
    "subnet": "1.1.1.1/32",
}

Response

HTTP/1.1 200 OK
{
    "compressionAdaptive": "true",
    "compressionBzip2": "true",
    "compressionDeflate": "true",
    "compressionLzo": "true",
    "compressionNull": "true",
    "deflateLevel": 1,
    "host": "www.foo.com",
    "portRange": "21",
    "subnet": "1.1.1.1/32",
    "name": "foo",
    "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"
}

Delete Network Access Optimized App Properties

DELETE /mgmt/cm/access/working-config/apm/resource/network-access/<id>/optimized-app/<id>

Response

HTTP/1.1 200 OK
{
    "compressionAdaptive": "true",
    "compressionBzip2": "true",
    "compressionDeflate": "true",
    "compressionLzo": "true",
    "compressionNull": "true",
    "deflateLevel": 1,
    "host": "www.foo.com",
    "portRange": "21",
    "subnet": "1.1.1.1/32",
    "name": "foo",
    "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"
}