Web service proxy commands
Web service proxy mode provides the commands to create or modify a web service proxy.
To enter the mode, use the global wsgw command. To delete a web service proxy, use the no wsgw command.
While in this mode, use the commands in the following table to define a web service proxy.
- To view the current configuration, use the show command.
- To restore default values, use the reset command.
- To exit this configuration mode without saving changes to the running configuration, use the cancel command.
- To exit this configuration mode and save changes to the running configuration, use the exit command.
| Command | Purpose |
|---|---|
| admin-state | This command sets the administrative state for the configuration. |
| aaa-policy | This command assigns a service-wide AAA policy to the web service proxy. |
| attachment-byte-count | This command specifies the maximum size for an attached document for the web service proxy. |
| attribute-count | This command sets the maximum number of attributes for an XML element for the web service proxy. |
| autocreate-sources | This command manages a default HTTP handler. |
| back-attachment-format | This command sets how to interpret server responses with attachments for the web service proxy. |
| back-persistent-timeout | This command sets the inter-transaction timeout for web service proxy to server connections. |
| back-timeout | This command sets the intra-transaction timeout for web service proxy to server connections. |
| backend-url | This command specifies the URL to which the web service proxy routes all traffic to the static remote server. |
| backside-port-rewrite | This command specifies the URL rewrite policy to modify the back-end WSDL-port address in the source WSDL file. |
| chunked-uploads | This command controls whether the web service proxy can send chunked-encoded documents to the target server. |
| client-principal | This command specifies the name of the Kerberos client principal to decrypt encrypted requests. |
| compression | This command controls the negotiation of GZIP compression between the web service proxy and the remote server. |
| decrypt-key | This command specifies the key to decrypt encrypted payload. |
| default-param-namespace | This command modifies the namespace for stylesheet parameters without an explicit namespace for the web service proxy. |
| delay-errors | This command controls whether the web service proxy delays error messages to avoid a padding oracle. |
| delay-errors-duration | This command specifies the duration that the web service proxy delays error messages after request decryption. |
| element-depth | This command sets the maximum depth of element nesting for the parse operation of the web service proxy. |
| enable-compressed-payload-passthrough | This command controls payload decompression when the response to the web service proxy is compressed. |
| endpoint-rewrite-policy | This command assigns an endpoint rewrite policy to the web service proxy. |
| external-references | This command defines how the web service proxy processes input documents that contain external references. |
| follow-redirects | This command controls the resolution of redirects for the web service proxy. |
| front-attachment-format | This command sets how to interpret client requests with attachments for the web service proxy. |
| front-persistent-timeout | This command sets the inter-transaction timeout for web service proxy-to-client connections. |
| front-protocol | This command controls the resolution of redirects for the web service proxy. |
| front-timeout | This command sets the intra-transaction timeout for web service proxy to client connections. |
| frontside-port-rewrite | This command controls the resolution of redirects for the web service proxy. |
| fwcred | This command sets the service keystore for the web service proxy. |
| gateway-parser-limits | This command indicates whether to use parser limits specific to the web service proxy. |
| host-rewriting | This command controls whether the web service proxy rewrites the
Host header to reflect the final route. |
| http-client-ip-label | This command identifies which HTTP header contains the client IP address for the web service proxy. |
| http-global-tranID-label | This command identifies which HTTP header contains the global transaction ID for the web service proxy. |
| http-server-version | This command sets the HTTP version for web service proxy to server connections. |
| include-content-type-encoding | This command sets the HTTP version for web service proxy to server connections. |
| inorder-mode | This command defines serial processing of queue-based messages during different parts of transactions through the web service proxy. |
| inject | This command injects a proprietary HTTP header field into the packet stream between the web service proxy and an HTTP client or server. |
| kerberos-keytab | This command specifies the keytab that contains the principals. |
| load-balancer-hash-header | This command specifies the keytab that contains the principals. |
| loop-detection | This command controls loop detection behavior in the network for the web service proxy. |
| max-local-names | This command specifies the maximum number of distinct XML local names in a document for the web service proxy. |
| max-message-size | This command specifies the maximum allowable size of a message for the web service proxy. |
| max-namespaces | This command specifies the maximum number of distinct XML namespace URIs in a document for the web service proxy. |
| max-node-size | This command specifies the maximum node size for the web service proxy. |
| max-prefixes | This command specifies the maximum number of distinct XML namespace prefixes in a document for the web service proxy. |
| mime-back-headers | This command controls MIME multipart messages over HTTP in server responses for the web service proxy. |
| mime-front-headers | This command controls MIME multipart messages sent over HTTP in client requests for the web service proxy. |
| monitor-count | This command manages count monitors for the web service proxy. |
| monitor-duration | This command manages duration monitors for the web service proxy. |
| monitor-processing-policy | This command sets the behavior when the web service proxy has multiple monitors. |
| monitor-service | This command manages web service monitors for the web service proxy. |
| operation-conformance | This command sets the operational conformance policy. |
| operation-policy-opt-out | This command sets the WS-Policy policy subjects to ignore. |
| operation-priority | This command defines the priority for a specific web services operation. |
| otel | This command associates an OpenTelemetry instance with the web service proxy. |
| otel-resource-attribute | This command manages the vector of OpenTelemetry resource attributes to augment the resource attributes in the OpenTelemetry instance for the web service proxy. |
| parameter | This command defines stylesheet parameters for the processing policy of the web service proxy. |
| persistent-connections | This command controls the negotiation of persistent connections for the web service proxy. |
| policy-parameters | This command assigns policy parameters for attached policy. |
| priority | This command sets the service-level priority for the web service proxy. |
| process-http-errors | This command indicates whether the web service proxy processes errors from the server. |
| process-response-rule-for-oneway-wsdls | This command specifies whether to enable response processing for WSDL files with a one-way transmission primitive. |
| propagate-uri | This command manages how the web service proxy propagates the local portion of URL from the URL given by the client to the URL to contact the remote server. |
| query-param-namespace | This command modifies the default namespace for parameters made available by URL query strings for the web service proxy. |
| reliable-messaging | This command controls reliable messaging properties. |
| remote-retry | This command manages the recovery policy for failed network connections. |
| request-attachments | This command specifies the processing mode for attachments in client requests for the web service proxy. |
| request-attachments-flow-control | This command controls the transmission rate of attachments in client requests to servers for the web service proxy. |
| request-type | This command characterizes the client-originated traffic stream for the web service proxy. |
| response-attachments | This command specifies the processing mode for attachments in server responses for the web service proxy. |
| response-attachments-flow-control | This command controls the transmission rate of attachments in server responses to clients for the web service proxy. |
| response-type | This command associates an XML manager with the web service proxy. |
| rewrite-errors | This command controls the rewriting of error messages for the web service proxy to avoid providing a padding oracle. |
| root-part-not-first-action | This command sets the action to take when the MIME message root part is not first for the web service proxy. |
| server-principal | This command specifies the Kerberos server principal to decrypt encrypted responses. |
| soap-action-policy | This command sets the SOAPAction header policy for
the web service proxy. |
| soap-schema-url | This command associates the schema to validate incoming SOAP messages for the web service proxy. |
| ssl-config-type | This command sets the TLS profile type for the web service proxy. |
| ssl-server | This command associates a TLS server profile with the web service proxy. |
| ssl-sni-server | This command associates a TLS SNI server profile with the web service proxy. |
| stream-output-to-back | This command specifies server-facing streaming behavior for the web service proxy. |
| stream-output-to-front | This command specifies client-facing streaming behavior for the web service proxy. |
| stylepolicy | This command assigns a processing policy to the web service proxy. |
| summary | This command specifies the brief, descriptive summary for the object instance. |
| suppress | This command deletes HTTP header fields from the packet stream for the web service proxy. |
| type | This command specifies the configuration type of the web service proxy. |
| urlrewrite-policy | This command associates a URL rewrite policy with the web service proxy. |
| user-policy | This command assigns a user-policy to the web service proxy. |
| wsa-back-protocol | This command specifies the handler to receive asynchronous server responses and forward them to the original client. |
| wsa-default-faultto | This command forces the inclusion of the FaultTo
element in WS-Addressing messages. |
| wsa-default-replyto | This command forces the inclusion of the ReplyTo
element in WS-Addressing messages. |
| wsa-faultto-rewrite | This command assigns a URL rewrite policy that rewrites the contents
of the WS-Addressing FaultTo element. |
| wsa-force | This command forces the inclusion of WS-Addressing headers into incoming, traditionally addressed messages. |
| wsa-genstyle | This command specifies the request-response transmission model between the web service proxy and the target server. |
| wsa-http-async-response-code | This command specifies the HTTP response code that the web service proxy sends to the client before the actual asynchronous server response is sent. |
| wsa-mode | This command sets the WS-Addressing mode. |
| wsa-require-aaa | This command mandates the successful AAA processing before the
WS-Addressing To element is trusted in the client request. |
| wsa-replyto-rewrite | This command identifies the URL rewrite policy to rewrite the contents
of the WS-Addressing ReplyTo element. |
| wsa-strip-headers | This command removes all WS-Addressing headers from an incoming message before the message is forwarded to the recipient. |
| wsa-timeout | This command specifies the asynchronous timeout value. |
| wsa-to-rewrite | This command assigns or removes a URL rewrite policy that rewrites the
contents of the WS-Addressing To element. |
| wsdl | This command manages source WSDL files for the web service proxy. |
| wsdl-cache-policy | This command defines a caching policy for WSDL files. |
| wsmagent-monitor | Specifies whether the web service proxy collects monitoring records automatically through a web services management agent. |
| wsmagent-monitor-capture-mode | This command specifies which message the web service proxy captures with the web services management agent. |
| wsrr-saved-search-subscription | Obtains web services through a WSRR saved search subscription. |
| wsrr-subscription | Obtains web services through a WSRR subscription. |
| xml-manager | This command associates an XML manager with the web service proxy. |
This mode provides the following deprecated commands. For details about these commands, see the
online help.
- wsrm
- wsrm-aaapolicy
- wsrm-destination-accept-create-sequence
- wsrm-destination-accept-offers
- wsrm-destination-inorder
- wsrm-destination-maximum-inorder-queue-length
- wsrm-destination-maximum-sequences
- wsrm-request-force
- wsrm-response-force
- wsrm-sequence-expiration
- wsrm-source-back-acks-to
- wsrm-source-exponential-backoff
- wsrm-source-front-acks-to
- wsrm-source-inactivity-close-interval
- wsrm-source-make-offer
- wsrm-source-maximum-queue-length
- wsrm-source-maximum-sequences
- wsrm-source-request-ack-count
- wsrm-source-request-create-sequence
- wsrm-source-response-create-sequence
- wsrm-source-retransmission-interval
- wsrm-source-retransmit-count
- wsrm-source-sequence-ssl