Skip to main content

vserver fpolicy policy external-engine show

Contributors
Suggest changes
PDFs

Display external engines

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The vserver fpolicy policy external-engine show command displays information about all FPolicy external engines belonging to the Vserver. Any Vserver administrator can see FPolicy external engines associated to their Vserver as well as external engines created by cluster administrator. The command output depends on the parameter or parameters specified with the command. If you do not specify any parameters, the command displays the following information about all FPolicy external engines:

  • Vserver name

  • FPolicy external engine name

  • List of primary FPolicy servers

  • List of secondary FPolicy servers

  • Port number for FPolicy service

  • FPolicy external engine type

  • FPolicy external engine format

You can specify the -fields parameter to specify which fields of information to display about FPolicy external engines. You can specify additional parameters to display only information that matches those parameters. For instance, to display information only about all external engines where the -port parameter is set to 9 , run the command with the -field parameter set to engine-name and -port parameter set to 9 .

You can specify the -instance parameter to display all information for all policies in a list format.

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command only displays the fields that you specify.

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all entries.

[-vserver <Vserver Name>] - Vserver

If you specify this parameter, the command displays information only about the FPolicy external engines for the specified Vserver. FPolicy external engines that the cluster administrator creates are visible in all Vservers.

[-engine-name <Engine name>] - Engine

If you specify this parameter, the command displays information only about the FPolicy external engine that you specify.

[-primary-servers <IP Address>,…​] - Primary FPolicy Servers

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified IP addresses as primary FPolicy servers.

[-port <integer>] - Port Number of FPolicy Service

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified port for the FPolicy service.

[-secondary-servers <IP Address>,…​] - Secondary FPolicy Servers

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified IP addresses as secondary FPolicy servers.

[-extern-engine-type <External Engine Type>] - External Engine Type

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified external engine type.

[-ssl-option {no-auth|server-auth|mutual-auth}] - SSL Option for External Communication

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified SSL option.

[-reqs-cancel-timeout <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Timeout for Canceling a Request (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified timeout for canceling a request.

[-reqs-abort-timeout <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Timeout for Aborting a Request (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified timeout for aborting a request.

[-status-req-interval <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Interval for Sending Status Requests (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified interval for sending status requests.

[-max-connection-retries <integer>] - Max Reconnect Attempt (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified maximum reconnect attempts.

[-max-server-reqs <integer>] - Maximum Outstanding Requests for FPolicy Server (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified FPolicy server maximum outstanding requests.

[-server-progress-timeout <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Timeout for Disconnecting Non-responsive Server (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified timeout for disconnecting non-responsive server.

[-keep-alive-interval <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Interval for Sending Keep-Alive Messages (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified keep-alive interval.

[-certificate-common-name <FQDN or Custom Common Name>] - FQDN or Custom Common Name

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified certificate common name.

[-certificate-serial <text>] - Serial Number of Certificate

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified certificate serial number.

[-certificate-ca <text>] - Certificate Authority

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified certificate authority name.

[-recv-buffer-size <integer>] - Receive Buffer Size (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified receive buffer size.

[-send-buffer-size <integer>] - Send Buffer Size (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified send buffer size.

[-session-timeout <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Session ID Purge Timeout During Reconnection (privilege: advanced)

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified session timeout.

[-is-resiliency-enabled {true|false}] - Is Resiliency Feature Enabled

If you specify this parameter set to true , the command displays information only about the FPolicy external engine or engines that has the resiliency feature enabled.

[-resiliency-max-retention-duration <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Maximum Notification Retention Duration

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified network outage duration.

[-resiliency-directory-path <text>] - Directory for Notification Storage

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified directory path.

[-extern-engine-format {xml|protobuf}] - External Engine Format

If you specify this parameter, the command displays information only about the FPolicy external engine or engines that use the specified engine format.

Examples

The following example displays the information about the configured external engines using the vserver fpolicy policy external-engine show command.

cluster1::> vserver fpolicy policy external-engine show
                              Primary           Secondary        External    External
 Vserver         Engine       Servers           Servers    Port  Engine Type Engine Format
 --------------- -----------  ----------------- ---------- ----- ----------- ------------
 Cluster         cserver_eng  9.9.9.9           -              9 synchronous xml
 vs1.example.com cserver_eng  9.9.9.9           -              9 synchronous protobuf
 vs1.example.com v1n1         1.1.1.1           2.2.2.2        1 synchronous protobuf
 vs2.example.com cserver_eng  9.9.9.9           -              9 synchronous xml
 vs2.example.com v2n1         3.3.3.3           5.5.5.5        2 synchronous xml
 5 entries were displayed.

The following example displays the information about all Vserver FPolicy external engines with the -port parameter set to 9.

cluster1::> vserver fpolicy policy external-engine show -fields engine-name -port 9
 vserver         engine-name
 --------------- -----------
 Cluster         cserver_eng
 vs1.example.com cserver_eng
 vs2.example.com cserver_eng
 3 entries were displayed.

The following example displays the values of all the advanced-level parameters for the external engine v1n1 in Vserver vs1.example.com.

cluster1::*> vserver fpolicy policy external-engine show -vserver vs1.example.com -engine-name v1n1 -instance
   (vserver fpolicy policy external-engine show)
Vserver: vs1.example.com
                                          Engine: v1n1
                         Primary FPolicy Servers: 1.1.1.1
                  Port Number of FPolicy Service: 1
                       Secondary FPolicy Servers: 2.2.2.2
                            External Engine Type: synchronous
                          External Engine Format: protobuf
           SSL Option for External Communication: no-auth
                 Timeout for Canceling a Request: 20s
                  Timeout for Aborting a Request: 40s
            Interval for Sending Status Requests: 10s
                           Max Reconnect Attempt: 5
 Maximum Outstanding Requests for FPolicy Server: 50
 Timeout for Disconnecting Non-responsive Server: 1m
        Interval for Sending Keep-Alive Messages: 2m
                      FQDN or Custom Common Name: -
                    Serial Number of Certificate: -
                           Certificate Authority: -
                             Receive Buffer Size: 0
                                Send Buffer Size: 0
    Session ID Purge Timeout During Reconnection: 10s
                   Is Resiliency Feature Enabled: true
         Maximum Notification Retention Duration: 3m
              Directory for Notification Storage: /fpolicy