17 Request Routers
17.1 Get-anynodeRequestRouters
Returns the configured request routers.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RequestRouter
The identifier or display name of the request router object.
Return Value Structure
The response body is strutured as an array. The array consists of RequestRouter JSON objects. A description for its fields is at section 29.86.1. For the JSON schema refer to section 29.86.2.
17.2 Add-anynodeRequestRouter
Creates a new request router.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the request router object.
-
Id
Type: String
-
ForwardingMode
This setting determines how incoming sessions are forwarded.
Type: RequestRouterForwardingMode
Possible values:
-
BI_DIRECTIONAL
-
PRIMARY_TO_SECONDARY_EDGE
-
SECONDARY_TO_PRIMARY_EDGE
-
DISABLED
-
-
OperationalStateConditionId
The id of the condition, that determines when the Request Router is operational.
Type: String
-
PrimarySideOptions
Type: RequestRouterSideOptions
-
SecondarySideOptions
Type: RequestRouterSideOptions
Return Value Structure
The response body is strutured as an array. The array consists of RequestRouter JSON objects. A description for its fields is at section 29.86.1. For the JSON schema refer to section 29.86.2.
17.3 Set-anynodeRequestRouter
Modifies a request router object.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RequestRouter
The identifier or display name of the request router object.
-
Id
Type: String
-
ForwardingMode
This setting determines how incoming sessions are forwarded.
Type: RequestRouterForwardingMode
Possible values:
-
BI_DIRECTIONAL
-
PRIMARY_TO_SECONDARY_EDGE
-
SECONDARY_TO_PRIMARY_EDGE
-
DISABLED
-
-
OperationalStateConditionId
The id of the condition, that determines when the Request Router is operational.
Type: String
-
PrimarySideOptions
Type: RequestRouterSideOptions
-
SecondarySideOptions
Type: RequestRouterSideOptions
Return Value Structure
The response body is strutured as an array. The array consists of RequestRouter JSON objects. A description for its fields is at section 29.86.1. For the JSON schema refer to section 29.86.2.
17.4 Remove-anynodeRequestRouter
Deletes a request router object.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RequestRouter
The identifier or display name of the request router object.
Return Value Structure
The response body is strutured as an array. The array consists of RequestRouter JSON objects. A description for its fields is at section 29.86.1. For the JSON schema refer to section 29.86.2.