system.mode

Summary

Resource

Operation

Description

System-Mode

PUT /api/app/v1/sys/mode/filter

Set to Filtering mode

PUT /api/app/v1/sys/mode/lite

Set to User mode

PUT /api/app/v1/sys/mode/primary

Set to Full Policy mode

Details

PUT /api/app/v1/sys/mode/filter

Switches the policy mode to Filtering Only mode.

New in version 1.0.

Warning

This command returns unescaped characters such as Unix new line character and octothorpe.

Query Parameters:

  • off_box_ip (required) – IPv4 address of the off box Policy Server

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Change to Filtering Only mode:

PUT /api/app/v1/sys/mode/filter?off_box_ip=10.206.6.68 HTTP/1.1
Accept: text/html

Example 1 - Response: Change to Filtering Only mode:

HTTP/1.1 200 OK
Content-Type: text/html

{
  "Result": "Successfully changed to filter mode."
}

Example 2 - Request: Attempt to change to an unreachable off box Policy Server:

PUT /api/app/v1/sys/mode/filter?off_box_ip=10.206.6.69 HTTP/1.1
Accept: text/html

Example 2 - Response: Attempt to change to an unreachable off box Policy Server:

HTTP/1.1 200 OK
Content-Type: text/html

{
  "Reason": "Change to filter mode FAILED. The Policy Server at 10.206.6.69 did not respond on port 55806.",
  "Status": "Failure"
}
PUT /api/app/v1/sys/mode/lite

Switches the policy mode to User Directory and Filtering Only mode.

New in version 1.0.

Warning

This command returns unescaped characters such as Unix new line character and octothorpe.

Query Parameters:

  • off_box_ip (required) – IPv4 address of the off box Policy Broker

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Change to User Directory and Filtering mode:

PUT /api/app/v1/sys/mode/lite?off_box_ip=10.206.6.68 HTTP/1.1
Accept: text/html

Example 1 - Response: Change to User Directory and Filtering mode:

HTTP/1.1 200 OK
Content-Type: text/html

{
  "Result": "Successfully changed to full policy mode."
}

Example 2 - Request: Attempt to change to an unreachable off box Policy Broker:

PUT /api/app/v1/sys/mode/lite?off_box_ip=10.206.6.69 HTTP/1.1
Accept: text/html

Example 2 - Response: Attempt to change to an unreachable off box Policy Broker:

HTTP/1.1 200 OK
Content-Type: text/html

{
  "Reason": "Change to policy lite mode FAILED. The Policy Source at 10.206.6.69 did not respond on port 55806 and/or 55880.",
  "Status": "Failure"
}
PUT /api/app/v1/sys/mode/primary

Switches the policy mode to Full Policy mode.

New in version 1.0.

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Change to Full Policy mode:

PUT /api/app/v1/sys/mode/primary HTTP/1.1
Accept: text/html

Example 1 - Response: Change to Full Policy mode:

HTTP/1.1 200 OK
Content-Type: text/html

{
  "Result": "Successfully changed to full policy mode."
}