diff --git a/community/docs/modules/ROOT/nav.adoc b/community/docs/modules/ROOT/nav.adoc index 7a27763bc..cd5a295f1 100644 --- a/community/docs/modules/ROOT/nav.adoc +++ b/community/docs/modules/ROOT/nav.adoc @@ -86,7 +86,6 @@ *** xref:Technical Documentation/Payara Server Documentation/Command Reference/add-library.adoc[add-library] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/add-resources.adoc[add-resources] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/appclient.adoc[appclient] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/apply-http-lb-changes.adoc[apply-http-lb-changes] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin-recorder-enabled.adoc[asadmin-recorder-enabled] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc[asadmin] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/attach.adoc[attach] @@ -118,9 +117,6 @@ *** xref:Technical Documentation/Payara Server Documentation/Command Reference/create-domain.adoc[create-domain] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/create-file-user.adoc[create-file-user] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-health-checker.adoc[create-http-health-checker] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-config.adoc[create-http-lb-config] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-ref.adoc[create-http-lb-ref] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb.adoc[create-http-lb] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-listener.adoc[create-http-listener] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-redirect.adoc[create-http-redirect] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http.adoc[create-http] @@ -180,9 +176,6 @@ *** xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-domain.adoc[delete-domain] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-file-user.adoc[delete-file-user] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-health-checker.adoc[delete-http-health-checker] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-config.adoc[delete-http-lb-config] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-ref.adoc[delete-http-lb-ref] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb.adoc[delete-http-lb] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-listener.adoc[delete-http-listener] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-redirect.adoc[delete-http-redirect] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http.adoc[delete-http] @@ -226,8 +219,6 @@ *** xref:Technical Documentation/Payara Server Documentation/Command Reference/deploy.adoc[deploy] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/deploydir.adoc[deploydir] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-asadmin-recorder.adoc[disable-asadmin-recorder] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-application.adoc[disable-http-lb-application] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-server.adoc[disable-http-lb-server] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-monitoring.adoc[disable-monitoring] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-phone-home.adoc[disable-phone-home] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-secure-admin-internal-user.adoc[disable-secure-admin-internal-user] @@ -235,15 +226,12 @@ *** xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-secure-admin.adoc[disable-secure-admin] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/disable.adoc[disable] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-asadmin-recorder.adoc[enable-asadmin-recorder] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-application.adoc[enable-http-lb-application] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-server.adoc[enable-http-lb-server] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-monitoring.adoc[enable-monitoring] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-phone-home.adoc[enable-phone-home] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-secure-admin-internal-user.adoc[enable-secure-admin-internal-user] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-secure-admin-principal.adoc[enable-secure-admin-principal] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-secure-admin.adoc[enable-secure-admin] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/enable.adoc[enable] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/export-http-lb-config.adoc[export-http-lb-config] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/export-sync-bundle.adoc[export-sync-bundle] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/export.adoc[export] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/flush-connection-pool.adoc[flush-connection-pool] @@ -328,8 +316,6 @@ *** xref:Technical Documentation/Payara Server Documentation/Command Reference/list-hazelcast-cluster-members.adoc[list-hazelcast-cluster-members] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/list-hazelcast-members.adoc[list-hazelcast-members] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/list-healthcheck-services.adoc[list-healthcheck-services] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-lb-configs.adoc[list-http-lb-configs] -*** xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-lbs.adoc[list-http-lbs] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-listeners.adoc[list-http-listeners] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/list-iiop-listeners.adoc[list-iiop-listeners] *** xref:Technical Documentation/Payara Server Documentation/Command Reference/list-instances.adoc[list-instances] diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/apply-http-lb-changes.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/apply-http-lb-changes.adoc deleted file mode 100644 index 195c9371b..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/apply-http-lb-changes.adoc +++ /dev/null @@ -1,71 +0,0 @@ -[[apply-http-lb-changes]] -= apply-http-lb-changes - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + - + -The documentation in this page may not be accurate. - -Applies load balancer configuration changes to the load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] apply-http-lb-changes [--help] -lb-name ----- - -[[description]] -== Description - -Use the `apply-http-lb-changes` subcommand to apply the changes in the load balancer configuration to the physical load balancer. The load balancer must already exist. To create a physical load balancer, use the `create-http-lb` subcommand. - -[[context]] -== Context - -The Load Balancer distributes the workload among multiple Payara Server instances , increasing the overall throughput of the system. The Load Balancer also enables requests to failover from one server instance to another. For HTTP session information to persist, configure HTTP session persistence. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. - -[[operands]] -== Operands - -lb-name:: - The name of the load balancer to which changes are applied. The load balancer must already exist. You can create it with the `create-http-lb` subcommand. - -[[examples]] -== Examples - -*Example 1 Using the `apply-http-lb-changes` subcommand* - -This example applies configuration changes to a load balancer named `mylb`. - -[source,shell] ----- -asadmin> apply-http-lb-changes mylb -Command apply-http-lb-changes executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb.adoc#create-http-lb[`create-http-lb`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-config.adoc#create-http-lb-config[`create-http-lb-config`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/configure-lb-weight.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/configure-lb-weight.adoc deleted file mode 100644 index a69c69a69..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/configure-lb-weight.adoc +++ /dev/null @@ -1,74 +0,0 @@ -[[configure-lb-weight]] -= configure-lb-weight - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + - + -The documentation in this page may not be accurate. - -Sets load balancing weights for clustered instances. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] configure-lb-weight [--help] ---cluster cluster_name -instance-name=weight[:instance-name=weight] ----- - -[[description]] -== Description - -The `configure-lb-weight` subcommand assigns weight to the server instances in a cluster. Weights can be used for HTTP, RMI/IIOP and JMS load balancing. For the HTTP load balancer, the weights are used only if the load balancer's policy is set to `weighted-round-robin`. -The load balancer policy is set in the `create-http-lb-ref` subcommand or `set` subcommand. - -Use the weight to vary the load going to different instances in the cluster. For example, if an instance is on a machine with more capacity, give it a higher weight so that more requests are sent to that instance by the load balancer. The default weight is 100. If all instances have the default weight, the load balancer performs simple round-robin load balancing. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--cluster`:: - The name of the cluster. - -[[operands]] -== Operands - -instance-name=weight:: - The name of the instance and the weight you are assigning it. The weight must be an integer. The pairs of instances and weights are - separated by colons. For example `instance1=1:instance2=4` means that for every five requests, one goes to instance1 and four go to instance2. A weight of 1 is the default. - -[[examples]] -== Examples - -*Example 1 Assigning Load Balancer Weights to Cluster Instances* - -The following subcommand assigns weights of `1`, `1`, and `2` to -instances `i1`, `i2`, and `i3` in the `cluster1` cluster. - -[source,shell] ----- -asadmin> configure-lb-weight --cluster cluster1 i1=1:i2=1:i3=2 -Command configure-lb-weight executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-ref.adoc#create-http-lb-ref[`create-http-lb-ref`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-cluster.adoc#create-cluster[`create-cluster`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-cluster.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-cluster.adoc index c562a7969..7efd5afdb 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-cluster.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-cluster.adoc @@ -16,12 +16,6 @@ asadmin [asadmin-options] create-cluster [--help] [--multicastport multicast-port] [--multicastaddress multicast-address] [--bindaddress bind-address] -[--hosts hadb-host-list] -[--haagentport port-number] -[--haadminpassword password] -[--haadminpasswordfile file-name] [--devicesize devicesize ] -[--haproperty (name=value)[:name=value]*] -[--autohadb=false] [--portbase port-number] cluster-name ---- @@ -193,30 +187,6 @@ To specify an address that is valid for all Payara Server instances in the clust + For example, use the `create-system-properties` subcommand to create the system property `GMS-BIND-INTERFACE-ADDRESS-` cluster-name. Then set the `--bindaddress` option of this subcommand to `${GMS-BIND-INTERFACE-ADDRESS-` cluster-name `}` to specify the system property. Finally, for each instance in the cluster, set the `GMS-BIND-INTERFACE-ADDRESS-` cluster-name system property to the required network interface address on the instance's machine. -`--hosts`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - -`--haagentport`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - -`--haadminpassword`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - -`--haadminpasswordfile`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - -`--devicesize`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - -`--haproperty`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - -`--autohadb`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - -`--portbase`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - [[operands]] == Operands diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-connector-connection-pool.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-connector-connection-pool.adoc index faebc852f..c92197e78 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-connector-connection-pool.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-connector-connection-pool.adoc @@ -8,8 +8,7 @@ Adds a connection pool with the specified connection pool name. [source,shell] ---- -asadmin [asadmin-options] create-connector-connection-pool [--help] -[--target=target] +asadmin [asadmin-options] create-connector-connection-pool [--help] --raname raname --connectiondefinition connectiondefinitionname [--steadypoolsize steadypoolsize] @@ -139,9 +138,6 @@ asadmin-options:: The name of the resource adapter. `--steadypoolsize`:: The minimum and initial number of connections maintained in the pool. Default value is 8. -`--target`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does - not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. `--transactionsupport`:: Indicates the level of transaction support that this pool will have. Possible values are `XATransaction`, `LocalTransaction` and `NoTransaction`. This attribute can have a value lower than or equal diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-connector-security-map.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-connector-security-map.adoc index d71573999..5ba657847 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-connector-security-map.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-connector-security-map.adoc @@ -13,7 +13,6 @@ asadmin [asadmin-options] create-connector-security-map [--help] [--principals principal-name1[,principal-name2]*] [--usergroups user-group1[,user-group2]*] [--mappedusername user-name] -[--target target] mapname ---- @@ -50,9 +49,6 @@ asadmin-options:: `--principals` or `--usergroups` options, but not both in the same command. `--mappedusername`:: Specifies the EIS username. -`--target`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does - not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. [[operands]] == Operands diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-domain.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-domain.adoc index d33ef1735..e4a261160 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-domain.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-domain.adoc @@ -12,7 +12,6 @@ asadmin [asadmin-options] create-domain [--help] [--adminport adminport] [--instanceport instanceport] [--portbase portbase] -[--profile profile-name] [--template template-name] [--domaindir domaindir] [--savemasterpassword={false|true}] @@ -84,9 +83,6 @@ asadmin-options:: * Felix shell service port for OSGi module management: portbase + 66 + When the `--portbase` option is specified, the output of this subcommand includes a complete list of used ports. + The `--portbase` option cannot be used with the `--adminport`, `--instanceport`, or the `--domainproperties` option. -`--profile`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does - not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. `--template`:: The file name, including a relative or absolute path, of a domain configuration template to use for creating the domain. If a relative path is specified, the subcommand appends the path to the as-install`/lib/templates` directory to locate the file. If it is an absolute pathname, the subcommand locates the file in the specified path. + diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-config.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-config.adoc deleted file mode 100644 index e8c16a7fc..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-config.adoc +++ /dev/null @@ -1,89 +0,0 @@ -[[create-http-lb-config]] -= create-http-lb-config - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Creates a configuration for the load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] create-http-lb-config [--help] -[--responsetimeout 60] -[httpsrouting=false] [--reloadinterval 60] -[--monitor=false] [--property (name=value)[:name=value]*] ---target target | config_name ----- - -[[description]] -== Description - -Use the `create-http-lb-config` subcommand to create a load balancer configuration. This configuration applies to load balancing in the HTTP path. After using this subcommand to create the load balancer configuration file, create the load balancer by running `create-http-lb`. - -You must specify either a target or a configuration name, or both. If you do not specify a target, the configuration is created without a target and you add one later using `create-http-lb-ref`. If you don't specify a configuration name, a name is created based on the target name. If you specify both, the configuration is created with the specified name, referencing the specified target. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--responsetimeout`:: - The time in seconds within which a server instance must return a response. If no response is received within the time period, the server is considered unhealthy. If set to a positive number, and the request is idempotent, the request is retried. If the request is not idempotent, an error page is returned. If set to 0 no timeout is used. The default is 60. -`--httpsrouting`:: - If set to `true`, HTTPS requests to the load balancer result in HTTPS requests to the server instance. If set to `false`, HTTPS requests to the load balancer result in HTTP requests to the server instance. The default is `false`. -`--reloadinterval`:: - The interval between checks for changes to the load balancer configuration file `loadbalancer.xml`. When the check detects changes, the configuration file is reloaded. A value of `0` disables reloading. -`--monitor`:: - Specifies whether monitoring is enabled. The default is `false`. -`--routecookie`:: - This option is deprecated. The value is always `true`. -`--property`:: - Optional attribute name/value pairs for configuring the load balancer. -`--target`:: - Specifies the target to which the load balancer configuration applies. If you don't specify a target, the load balancer configuration is created without a target. You can specify targets later using the subcommand `create-http-lb-ref`. + - Valid values are: + - * cluster_name - Specifies that requests for this cluster will be handled by the load balancer. - * stand-alone_instance_name - Specifies that requests for this standalone instance will be handled by the load balancer. - -[[operands]] -== Operands - -config_name:: - The name of the new load balancer configuration. This name must not conflict with any other load balancer groups, agents, configurations, clusters, or sever instances in the domain. If you don't specify a name, the load balancer configuration name is based on the target name, target_name`-http-lb-config`. - -[[examples]] -== Examples - -*Example 1 Creating a Load Balancer Configuration* - -This example creates a load balancer configuration on a target named `mycluster` and load balancer configuration named `mylbconfigname`. - -[source,shell] ----- -asadmin> create-http-lb-config --target mycluster mylbconfigname - -Command create-http-lb-config executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-config.adoc#delete-http-lb-config[`delete-http-lb-config`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-lb-configs.adoc#list-http-lb-configs[`list-http-lb-configs`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb.adoc#create-http-lb[`create-http-lb`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-ref.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-ref.adoc deleted file mode 100644 index 7de88caf2..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-ref.adoc +++ /dev/null @@ -1,142 +0,0 @@ -[[create-http-lb-ref]] -= create-http-lb-ref - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Adds an existing cluster or server instance to an existing load balancer configuration or load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] create-http-lb-ref [--help] ---config config_name | --lbname load_balancer_name -[--lbpolicy round-robin] [--lbpolicymodule lb_policy_module] -[--healthcheckerurl url] [--healthcheckerinterval 10] -[--healthcheckertimeout 10] [--lbenableallinstances=true] -[--lbenableallapplications=true] [--lbweight instance=weight[:instance=weight]*] -target ----- - -[[description]] -== Description - -Use the `create-http-lb-ref` subcommand to: - -* Add an existing cluster or server instance to an existing load balancer configuration or load balancer. The load balancer forwards the requests to the clustered and standalone instances it references. -* Set the load balancing policy to round-robin, weighted round-robin, or to a user-defined policy. -* Configure a health checker for the load balancer. Any health checker settings defined here apply only to the target. If you do not create a health checker with this subcommand, use `create-http-health-checker`. -* Enable all instances in the target cluster for load balancing, or use `enable-http-lb-server` to enable them individually. -* Enable all applications deployed to the target for load balancing, or use `enable-http-lb-application` to enable them individually. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--config`:: - Specifies which load balancer configuration to which to add clusters and server instances. Specify either a load balancer configuration or a load balancer. Specifying both results in an error. -`--lbname`:: - Specifies the load balancer to which to add clusters and server instances. Specify either a load balancer configuration or a load balancer. Specifying both results in an error. -`--lbpolicy`:: - The policy the load balancer follows. Valid values are `round-robin`, `weighted-round-robin`, and `user-defined`. If you choose user-defined, specify a load balancer policy module with the - `lbpolicymodule` option. If you choose `weighted-round-robin` assign weights to the server instances using the `configure-lb-weight` subcommand. The default is `round-robin`. -`--lbpolicymodule`:: - If your load balancer policy is `user-defined`, use this option to specify the full path and name of the shared library of your load balancing policy module. The shared library needs to be in a location accessible by the web server. -`--healthcheckerurl`:: - The URL to ping to determine whether the instance is healthy. -`--healthcheckerinterval`:: - The interval in seconds the health checker waits between checks of an unhealthy instance to see whether it has become healthy. The default value is 30 seconds. A value of 0 disables the health checker. -`--healthcheckertimeout`:: - The interval in seconds the health checker waits to receive a response from an instance. If the health checker has not received a response in this interval, the instance is considered unhealthy. The default is 10. -`--lbenableallinstances`:: - Enables all instances in the target cluster for load balancing. If the target is a server instance, enables that instance for load balancing. The default value is true. -`--lbenableallapplications`:: - Enables all applications deployed to the target cluster or instance for load balancing. The default value is true. -`--lbweight`:: - The name of the instance and the weight you are assigning it. - The weight must be an integer. The pairs of instances and weights are separated by colons. For example `instance1=1:instance2=4` means that for every five requests, one goes to instance1 and four go to instance2. A weight of 1 is the default. - -[[operands]] -== Operands - -target:: - Specifies which cluster or instance to add to the load balancer. Valid values are: + - * cluster_name - Specifies that requests for this cluster will be handled by the load balancer. - * stand-alone_instance_name - Specifies that requests for this standalone instance will be handled by the load balancer. - -[[examples]] -== Examples - -*Example 1 Adding a Cluster Reference to a Load Balancer Configuration* - -This example adds a reference to a cluster named `cluster2` to a load balancer configuration named `mylbconfig`. - -[source,shell] ----- -asadmin> create-http-lb-ref --config mylbconfig cluster2 - -Command create-http-lb-ref executed successfully. ----- - -*Example 2 Adding a Cluster Reference to a Load Balancer* - -This example adds a reference to a cluster named `cluster2` to a load balancer named `mylb`. - -[source,shell] ----- -asadmin> create-http-lb-ref --lbname mylb cluster2 - -Command create-http-lb-ref executed successfully. ----- - -*Example 3 Configuring a Health Checker and Load Balancer Policy* - -This example configures a health checker and load balancing policy, and enables the load balancer for instances and applications. - -[source,shell] ----- -asadmin> create-http-lb-ref --config mylbconfig --lbpolicy weighted-round-robin ---healthcheckerinterval 40 --healthcheckertimeout 20 ---lbenableallinstances=true --lbenableallapplications=true cluster2 - -Command create-http-lb-ref executed successfully. ----- - -*Example 4 Setting a User-Defined Load Balancing Policy* - -This example sets a user-defined load balancing policy. - -[source,shell] ----- -asadmin> create-http-lb-ref --lbpolicy user-defined --lbpolicymodule /user/modules/module.so ---config mylbconfig cluster2 - -Command create-http-lb-ref executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/configure-lb-weight.adoc#configure-lb-weight[`configure-lb-weight`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-health-checker.adoc#create-http-health-checker[`create-http-health-checker`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-ref.adoc#delete-http-lb-ref[`delete-http-lb-ref`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-application.adoc#enable-http-lb-application[`enable-http-lb-application`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-server.adoc#enable-http-lb-server[`enable-http-lb-server`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-lb-configs.adoc#list-http-lb-configs[`list-http-lb-configs`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-lbs.adoc#list-http-lbs[`list-http-lbs`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb.adoc deleted file mode 100644 index 1b697f04e..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb.adoc +++ /dev/null @@ -1,131 +0,0 @@ -[[create-http-lb]] -= create-http-lb - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Creates a load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] create-http-lb [--help] ---devicehost device_host_or_IP_address --deviceport device_port -[--sslproxyhost proxy_host] -[--sslproxyport proxy_port] [--target target] [--lbpolicy lbpolicy] [--lbpolicymodule lb_policy_module] [--healthcheckerurl url] -[--healthcheckerinterval 10] [--healthcheckertimeout 10] -[--lbenableallinstances=true] [--lbenableallapplications=true] [--lbweight instance=weight[:instance=weight]*] [--responsetimeout 60] [--httpsrouting=false] [--reloadinterval60][--monitor=false][--routecookie=true] -[--property (name=value)[:name=value]* -] load_balancer_name ----- - -[[description]] -== Description - -Use the `create-http-lb` subcommand to create a load balancer, including the load balancer configuration, target reference, and health checker. A -load balancer is a representation of the actual load balancer device, defined by its device host and port information. Once you've created the -load balancer, you can automatically apply changes made to the load balancer configuration without running `export-http-lb-config` and -manually copying the generated load balancer configuration file to the web server instance. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--devicehost`:: - The device host or the IP address of the load balancing device. This host or IP is where the physical load balancer will reside. -`--deviceport`:: - The port used to communicate with the load balancing device. It must be SSL enabled. -`--sslproxyhost`:: - The proxy host used for outbound HTTP. -`--sslproxyport`:: - The proxy port used for outbound HTTP. -`--target`:: - Specifies the target to which the load balancer applies. + - Valid values are: + - * cluster_name- Specifies that requests for this cluster will be handled by the load balancer. - * stand-alone_instance_name- Specifies that requests for this stand-alone instance will be handled by the load balancer. -`--lbpolicy`:: - The policy the load balancer follows to distribute load to the server - instances in a cluster. Valid values are `round-robin`, `weighted-round-robin`, and `user-defined`. If you choose - `user-defined`, specify a load balancer policy module with the `lbpolicymodule` option. If you choose `weighted-round-robin`, assign - weights to the server instances using the `configure-lb-weight` subcommand. The default is `round-robin`. -`--lbpolicymodule`:: - If your target is a cluster and the load balancer policy is `user-defined`, use this option to specify the full path and name of - the shared library of your load balancing policy module. The shared library needs to be in a location accessible by the web server. -`--healthcheckerurl`:: - The URL to ping to determine whether the instance is healthy. -`--healthcheckerinterval`:: - The interval in seconds the health checker waits between checks of an - unhealthy instance to see whether it has become healthy. The default value is 10 seconds. A value of 0 disables the health checker. -`--healthcheckertimeout`:: - The interval in seconds the health checker waits to receive a response from an instance. If the health checker has not received a response in - this interval, the instance is considered unhealthy. The default value is 10 seconds. -`--lbenableallinstances`:: - Enables all instances in the target cluster for load balancing. If the - target is a server instance, enables that instance for load balancing. -`--lbenableallapplications`:: - Enables all applications deployed to the target cluster or instance for load balancing. -`--lbweight`:: - The name of the instance and the weight you are assigning it. The - weight must be an integer. The pairs of instances and weights are separated by colons. For example `instance1=1:instance2=4` means that - for every five requests, one goes to instance1 and four go to instance2. A weight of 1 is the default. -`--responsetimeout`:: - The time in seconds within which a server instance must return a response. If no response is received within the time period, the - server is considered unhealthy. If set to a positive number, and the request is idempotent, the request is retried. If the request is not - idempotent, an error page is returned. If set to 0 no timeout is used. The default is 60. -`--httpsrouting`:: - If set to `true`, HTTPS requests to the load balancer result in HTTPS requests to the server instance. If set to `false`, HTTPS requests to - the load balancer result in HTTP requests to the server instance. The default is `false`. -`--reloadinterval`:: - The time, in seconds, that the load balancer takes to check for an updated configuration. When detected, the configuration file is - reloaded. The default value is 60 seconds. A value of 0 disables reloading. -`--monitor`:: - If set to `true`, monitoring of the load balancer is switched on. The default value is `false`. -`--routecookie`:: - This option is deprecated. The value is always true. -`--property`:: - Optional attribute name/value pairs for configuring the load balancer. - -[[operands]] -== Operands - -lb_name:: - The name of the new load balancer. This name must not conflict with any other load balancers in the domain. - -[[examples]] -== Examples - -*Example 1 Creating a Load Balancer* - -This example creates a load balancer named `mylb`. - -[source,shell] ----- -asadmin> create-http-lb ---devicehost host1 --deviceport 5555 mylb - -Command create-http-lb executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb.adoc#delete-http-lb[`delete-http-lb`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-lbs.adoc#list-http-lbs[`list-http-lbs`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-config.adoc#create-http-lb-config[`create-http-lb-config`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-listener.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-listener.adoc index b305f641d..6eb2cf6c4 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-listener.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-http-listener.adoc @@ -14,8 +14,7 @@ asadmin [asadmin-options] create-http-listener [--help] {--default-virtual-server | --defaultvs} virtual-server [--servername server-name] [--acceptorthreads acceptor-threads] -[--redirectport redirect-port] -[--securityenabled={false|true}] +[--securityenabled={false|true}] [--enabled={true|false}] [--target target] listener-id @@ -50,8 +49,6 @@ asadmin-options:: This affects URLs the server automatically generates; it doesn't affect the URLs for directories and files stored in the server. This name should be the alias name if your server uses an alias. If a colon and port number are appended, that port will be used in URLs that the server sends to the client. `--acceptorthreads`:: The number of acceptor threads for the listener socket. The recommended value is the number of processors in the machine. The default value is 1. -`--redirectport`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. `--securityenabled`:: If set to true, the HTTP listener runs SSL. You can turn SSL2 or SSL3 ON or OFF and set ciphers using an SSL element. The security setting globally enables or disables SSL by making certificates available to the server instance. The default value is `false`. `--enabled`:: diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-jdbc-connection-pool.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-jdbc-connection-pool.adoc index e1a96aa08..98336fa06 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-jdbc-connection-pool.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-jdbc-connection-pool.adoc @@ -48,7 +48,6 @@ asadmin [asadmin-options] create-jdbc-connection-pool [--help] [--description description] [--property name=value)[:name=value]*] [--skipclientinfovalidation={false|true}] -[--target=target] connectionpoolid ---- @@ -231,9 +230,6 @@ NOTE: If an attribute name or attribute value contains a colon, the backslash (` NOTE: Skipping client info validation may improve the performance of persistent operations when pooling is disabled and managed by the JDBC driver. -`--target`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - [[operands]] == Operands diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-resource-adapter-config.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-resource-adapter-config.adoc index 49d9fe0f9..bcca72608 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-resource-adapter-config.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-resource-adapter-config.adoc @@ -34,8 +34,6 @@ asadmin-options:: `--help`:: `-?`:: Displays the help text for the subcommand. -`--target`:: - This option has been deprecated. `--threadpoolid`:: The thread pool ID from which the work manager gets the thread. This option takes only one thread pool ID. `--objecttype`:: diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-threadpool.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-threadpool.adoc index d5af94d5c..a3af9f0e5 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-threadpool.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/create-threadpool.adoc @@ -13,7 +13,7 @@ asadmin [asadmin-options] create-threadpool [--help] [--maxthreadpoolsize maxthreadpoolsize] [--minthreadpoolsize minthreadpoolsize] [--idletimeout idletimeout] [--maxqueuesize maxqueuesize] -[--workqueues workqueues] threadpool-id +threadpool-id ---- [[description]] @@ -53,9 +53,6 @@ asadmin-options:: Specifies the amount of time in seconds after which idle threads are removed from the pool. Default is 900. `--maxqueuesize`:: Specifies the maximum number of messages that can be queued until threads are available to process them for a network listener or IIOP listener. A value of -1 specifies no limit. Default is 4096. -`--workqueues`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does - not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. [[operands]] == Operands diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-cluster.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-cluster.adoc index b3cdcb5b8..760a727ee 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-cluster.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-cluster.adoc @@ -9,7 +9,6 @@ deletes a Payara Server cluster [source,shell] ---- asadmin [asadmin-options] delete-cluster [--help] -[--autohadboverride={true|false}] [--node-agent=node-agent--name] cluster-name ---- @@ -33,10 +32,6 @@ asadmin-options:: `--help`:: `-?`:: Displays the help text for the subcommand. -`--autohadboverride`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. -`--nodeagent`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. [[operands]] == Operands diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-connector-connection-pool.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-connector-connection-pool.adoc index 52d2f51c1..1f4a4fefd 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-connector-connection-pool.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-connector-connection-pool.adoc @@ -8,8 +8,7 @@ Removes the specified connector connection pool. [source,shell] ---- -asadmin [asadmin-options] delete-connector-connection-pool [--help] -[--target target] +asadmin [asadmin-options] delete-connector-connection-pool [--help] [--cascade={false|true}] poolname ---- @@ -28,8 +27,6 @@ asadmin-options:: `--help`:: `-?`:: Displays the help text for the subcommand. -`--target`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. `--cascade`:: When set to true, all connector resources associated with the pool, and the pool itself, are deleted. When set to false, the deletion of pool fails if any resources are associated with the pool. The resource must be deleted explicitly or the option must be set to true. Default is false. diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-connector-security-map.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-connector-security-map.adoc index fa686737b..a05648438 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-connector-security-map.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-connector-security-map.adoc @@ -9,7 +9,7 @@ Celetes a security map for the specified connector connection pool. [source,shell] ---- asadmin [asadmin-options] delete-connector-security-map [--help] ---poolname connector_connection_pool_name [--target target] mapname +--poolname connector_connection_pool_name mapname ---- [[description]] @@ -31,8 +31,6 @@ asadmin-options:: Displays the help text for the subcommand. `--poolname`:: Specifies the name of the connector connection pool to which the security map that is to be deleted belongs. -`--target`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. [[operands]] == Operands diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-config.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-config.adoc deleted file mode 100644 index 781d8778a..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-config.adoc +++ /dev/null @@ -1,65 +0,0 @@ -[[delete-http-lb-config]] -= delete-http-lb-config - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Deletes a load balancer configuration. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] delete-http-lb-config [--help] -config_name ----- - -[[description]] -== Description - -Use the `delete-http-lb-config` subcommand to delete a load balancer configuration. The load balancer configuration must not reference any clusters or server instances enabled for load balancing. In addition, the load balancer configuration must not be referenced by any physical load balancers. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. - -[[operands]] -== Operands - -config_name:: - The name of the load balancer configuration to delete. The configuration must not reference any clusters or server instances enabled for load balancing, or be used by any physical load balancers. - -[[examples]] -== Examples - -*Example 1 Deleting a Load Balancer Configuration* - -This example deletes a load balancer configuration named `mylbconfig` - -[source,shell] ----- -asadmin> delete-http-lb-config mylbconfig -Command delete-http-lb-config executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-config.adoc#create-http-lb-config[`create-http-lb-config`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-lb-configs.adoc#list-http-lb-configs[`list-http-lb-configs`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-ref.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-ref.adoc deleted file mode 100644 index cc65c469f..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-ref.adoc +++ /dev/null @@ -1,78 +0,0 @@ -[[delete-http-lb-ref]] -= delete-http-lb-ref - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Deletes the cluster or server instance from a load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] delete-http-lb-ref [--help] ---config config_name | --lbname load_balancer_name -[--force=false] target ----- - -[[description]] -== Description - -Use the `delete-http-lb-ref` subcommand to remove a reference to a cluster or standalone server instance from a load balancer configuration or load balancer. So that you do not interrupt user requests, make sure the standalone server instance or all server instances in the cluster are disabled before you remove them from the load balancer configuration. If the `force` option is set to true, the references are deleted even if server instances or clusters are enabled. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--config`:: - Specifies which load balancer configuration to delete cluster and server instance references from. + - Specify either a load balancer configuration or a load balancer. Specifying both results in an error. -`--lbname`:: - Specifies the load balancer to delete cluster and server instance references from. + - Specify either a load balancer configuration or a load balancer. Specifying both results in an error. -`--force`:: - If `force` is set to true, then the references are deleted even if there are currently enabled applications or instances. The default is false. - -[[operands]] -== Operands - -target:: - Specifies which cluster or instance to remove from the load balancer. Valid values are: + - * cluster_name - The name of a target cluster. - * instance_name - The name of a target server instance. - -[[examples]] -== Examples - -[[example-1]] -*Example 1 Deleting a Cluster Reference from a Load Balancer Configuration* - -This example deletes the reference to cluster named `cluster2` from a load balancer configuration named `mycluster-http-lb-config`. - -[source,shell] ----- -asadmin> delete-http-lb-ref --config mycluster-http-lb-config cluster2 - -Command delete-http-lb-ref executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-ref.adoc#create-http-lb-ref[`create-http-lb-ref`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-server.adoc#disable-http-lb-server[`disable-http-lb-server`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb.adoc deleted file mode 100644 index 9d721ee56..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb.adoc +++ /dev/null @@ -1,66 +0,0 @@ -[[delete-http-lb]] -= delete-http-lb - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Deletes a load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] delete-http-lb [--help] -load_balancer_name ----- - -[[description]] -== Description - -Use the `delete-http-lb` subcommand to delete a physical load balancer. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. - -[[operands]] -== Operands - -load_balancer_name:: - The name of the load balancer to be deleted. - -[[examples]] -== Examples - -*Example 1 Deleting a Load Balancer Configuration* - -This example deletes the load balancer configuration named `mylb`. - -[source,shell] ----- -asadmin> delete-http-lb mylb - -Command delete-http-lb executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb.adoc#create-http-lb[`create-http-lb`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-lbs.adoc#list-http-lbs[`list-http-lbs`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-jdbc-connection-pool.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-jdbc-connection-pool.adoc index 8a71e5d56..08527ff08 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-jdbc-connection-pool.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-jdbc-connection-pool.adoc @@ -10,7 +10,6 @@ Removes the specified JDBC connection pool. ---- asadmin [asadmin-options] delete-jdbc-connection-pool [--help] [--cascade={false|true}] -[--target target] jdbc_connection_pool_id ---- @@ -31,8 +30,6 @@ asadmin-options:: Displays the help text for the subcommand. `--cascade`:: If the option is set to true, all the JDBC resources associated with the pool, apart from the pool itself, are deleted. When set to false, the deletion of pool fails if any resources are associated with the pool. Resources must be deleted explicitly or the option must be set to true. The default value is false. -`--target`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. [[operands]] == Operands diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-resource-adapter-config.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-resource-adapter-config.adoc index 9ac402e38..0dd8676c9 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-resource-adapter-config.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/delete-resource-adapter-config.adoc @@ -27,8 +27,6 @@ asadmin-options:: `--help`:: `-?`:: Displays the help text for the subcommand. -`--target`:: - This option is deprecated. [[operands]] == Operands diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-application.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-application.adoc deleted file mode 100644 index 5a70130ee..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-application.adoc +++ /dev/null @@ -1,79 +0,0 @@ -[[disable-http-lb-application]] -= disable-http-lb-application - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + - + -The documentation in this page may not be accurate. - -Disables an application managed by a load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] disable-http-lb-application [--help] -[--timeout 30] ---name application_name target ----- - -[[description]] -== Description - -The `disable-http-lb-application` subcommand disables an application for load balancing. The disabled application goes offline for load balancing with minimal impact to users. Disabling an application gives a finer granularity of control than disabling a server instance and is most useful when a cluster is hosting multiple independent applications. - -Once the application is disabled and the changes have been applied to the load balancer, new requests for the application are not forwarded to the target. Existing sessions continue to access the application until the timeout is reached. This process is known as quiescing. - -If an application is deployed across multiple clusters, use this subcommand to disable it in one cluster while leaving it enabled in others. - -If an application is deployed to a single server instance, use this subcommand to disable it in that instance while leaving the instance itself enabled. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--timeout`:: - The timeout (in minutes) to wait before disabling the specified application. This time allows for the graceful shutdown (quiescing) of the specified application. The default value is 30 minutes. The minimum value is 1 minute. -`--name`:: - The name of the application to be disabled. - -[[operands]] -== Operands - -target:: - This operand specifies the server instance or cluster on which to disable the application. Valid values are: + - * cluster_name - The name of a target cluster. - * instance_name - The name of a target server instance. - -[[examples]] -== Examples - -*Example 1 Disabling an Application for Load Balancing* - -This example, disables an application for load balancing - -[source,shell] ----- -asadmin> disable-http-lb-application --name webapps-simple mycluster - -Command disable-http-lb-application executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-application.adoc#enable-http-lb-application[`enable-http-lb-application`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-server.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-server.adoc deleted file mode 100644 index 854d25785..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-server.adoc +++ /dev/null @@ -1,77 +0,0 @@ -[[disable-http-lb-server]] -= disable-http-lb-server - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Disables a server or cluster managed by a load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] disable-http-lb-server [--help] -[--timeout 30] -target ----- - -[[description]] -== Description - -The `disable-http-lb-server` subcommand disables a standalone server or cluster of servers for load balancing. The disabled server instance or cluster goes offline for load balancing with a minimum impact to users. - -Once the target has been disabled and the changes have been applied to the load balancer, the load balancer stops assigning new requests to the target. Session requests with sessions created before disabling the target continue to be assigned to that target until the timeout is reached. This process is known as quiescing. - -Changes are applied the load balancer automatically. You can also manually export the configuration using `export-http-lb-config` and copy it to the load balancer. - -[[options]] -== Options - -asadmin-options:: -Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--timeout`:: -The timeout (in minutes) to wait before disabling the specified target. This time allows for the graceful shutdown (quiescing) of the specified target. The default value is 30 minutes. The minimum value is 1 minute. - -[[operands]] -== Operands - -target:: - This operand specifies which server instances and clusters to disable. Valid values are: + - * cluster_name - The name of a target cluster. - * instance_name - The name of a target server instance. - -[[examples]] -== Examples - -[[example-1]] - -*Example 1 Disabling a Cluster for Load Balancing* - -This example disables load balancing for a cluster named `mycluster`. - -[source,shell] ----- -asadmin> disable-http-lb-server mycluster - -Command disable-http-lb-server executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-ref.adoc#create-http-lb-ref[`create-http-lb-ref`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-server.adoc#enable-http-lb-server[`enable-http-lb-server`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-application.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-application.adoc deleted file mode 100644 index a8a94d7dc..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-application.adoc +++ /dev/null @@ -1,69 +0,0 @@ -[[enable-http-lb-application]] -= enable-http-lb-application - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Enables a previously-disabled application managed by a load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] enable-http-lb-application [--help] ---name application_name target ----- - -[[description]] -== Description - -The `enable-http-lb-application` subcommand enables load balancing for applications deployed on a standalone instance or cluster. You can enable load balancing for an application on all instances in a cluster, or on a single standalone server instance. By default, load balancing is enabled for applications. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--name`:: - The name of the application to be enabled. - -[[operands]] -== Operands - -target:: - This operand specifies on which server instance or cluster to enable the application. Valid values are: + - * cluster_name - The name of a target cluster. - * instance_name - The name of a target server instance. - -[[examples]] -== Examples - -*Example 1 Enabling Load Balancing for an Application* - -This example enables an application named `webapps-simple` to use load balancing on a cluster named `mycluster`. - -[source,shell] ----- -asadmin> enable-http-lb-application --name webapps-simple mycluster - -Command enable-http-lb-application executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-application.adoc#disable-http-lb-application[`disable-http-lb-application`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-server.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-server.adoc deleted file mode 100644 index 105b00080..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/enable-http-lb-server.adoc +++ /dev/null @@ -1,68 +0,0 @@ -[[enable-http-lb-server]] -== enable-http-lb-server - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Enables a previously disabled sever or cluster managed by a load balancer. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] enable-http-lb-server [--help] -target ----- - -[[desceiption]] -== Description - -The `enable-http-lb-server` subcommand enables a standalone server instance or cluster for load balancing. By default, load balancing is enabled for instances and clusters. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. - -[[operands]] -== Operands - -target:: - This operand specifies which server instances and clusters to enable. Valid values are: + - * cluster_name - The name of a target cluster. - * instance_name - The name of a target server instance. - -[[examples]] -== Examples - -*Example 1 Enabling a Cluster for Load Balancing* - -This example enables load balancing for a cluster named `mycluster`. - -[source,shell] ----- -asadmin> enable-http-lb-server mycluster - -Command enable-http-lb-server executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-ref.adoc#create-http-lb-ref[`create-http-lb-ref`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/disable-http-lb-server.adoc#disable-http-lb-server[`disable-http-lb-server`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/export-http-lb-config.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/export-http-lb-config.adoc deleted file mode 100644 index d79bd23af..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/export-http-lb-config.adoc +++ /dev/null @@ -1,98 +0,0 @@ -[[export-http-lb-config]] -= export-http-lb-config - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Exports the load balancer configuration or load balancer to a file. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] export-http-lb-config [--help] ---config config_name | --lbname load_balancer_name -[--target target] [--retrievefile=false] [file_name] ----- - -[[description]] -== Description - -The `export-http-lb-config` subcommand exports a load balancer configuration or load balancer into a file that the load balancer plug-in can use. The default file name is `loadbalancer.xml`, but you can specify a different name. Once exported, you manually copy the exported file to the load balancer plug-in location before configuration changes are applied. The `--target` option makes it possible to generate a `loadbalancer.xml` for clusters or standalone instances without having to manually create `lb-config` or `load-balancer` elements in the target's `domain.xml`. - -To apply changes to the load balancer without manually copying the configuration file, configure the load balancer to automatically apply changes with `create-http-lb`. If you use the `create-http-lb` subcommand, you do not need to use `export-http-lb-config`. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--config`:: - Specifies which load balancer configuration to export. + - Specify either a load balancer configuration or a load balancer. Specifying both results in an error. -`--lbname`:: - Specifies the load balancer to export. + - Specify either a load balancer configuration or a load balancer. Specifying both results in an error. -`--retrievefile`:: - If set to `true`, retrieves the `loadbalancer.xml` file from the remote machine. The default is `false`. -`--target`:: - Specifies the target to which the load balancer configuration will be exported. If a target is not specified, the load balancer configuration is exported to the location specified with file_name. - -[[operands]] -== Operands - -file_name:: - Specifies the file name and location of the exported configuration. + - * If you specify a directory (relative or absolute) but not a file name, the file named `loadbalancer.xml.`load_balancer_config_name is created in the specified directory. On Microsoft Windows systems the path must be in quotes. - * If you specify a file name in a relative or absolute path, the file is created with the name you specify in the directory you specify. - * If you specify a file name but do not specify a directory, the file is created with that name in the current working directory. - * If you do not specify this operand, the default value is a file named `loadbalancer.xml.`load_balancer_config_name created in the domain-dir`/generated` directory. -target:: - Specifies the target to which the configuration will be exported. + - Valid values are: + - * cluster_name - Specifies a cluster and its server instances. - * stand-alone_instance_name - Specifies a specific server instance. - -[[examples]] -== Examples - -*Example 1 Exporting a Load Balancer Configuration on UNIX* - -The following example exports a load balancing configuration named `mycluster-http-lb-config` to a file named `loadbalancer.xml` in the `/Sun/AppServer` directory . - -[source,shell] ----- -asadmin> export-http-lb-config --config mycluster-http-lb-config /Sun/AppServer/loadbalancer.xml -Command export-http-lb-config executed successfully. ----- - -*Example 2 Exporting a Load Balancer Configuration on Windows* - -The following example exports a load balancing configuration named `mycluster-http-lb-config` to a file named `loadbalancer.xml` in the `C:\Sun\AppServer` directory on a Microsoft Windows system. - -[source,shell] ----- -asadmin> export-http-lb-config --config mycluster-http-lb-config "C:\Sun\AppServer\loadbalancer.xml" -Command export-http-lb-config executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb.adoc#create-http-lb[`create-http-lb`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-config.adoc#create-http-lb-config[`create-http-lb-config`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/list-http-lb-configs.adoc#list-http-lb-configs[`list-http-lb-configs`] - - diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-connector-security-maps.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-connector-security-maps.adoc index a031c06e4..2f7839158 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-connector-security-maps.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-connector-security-maps.adoc @@ -10,7 +10,7 @@ Lists the security maps belonging to the specified connector connection pool. ---- asadmin [asadmin-options] list-connector-security-maps [--help] [--securitymap securitymap] -[--verbose={false|true}] [--target target] +[--verbose={false|true}] pool-name ---- @@ -35,8 +35,6 @@ asadmin-options:: Specifies the name of the security map contained within the connector connection pool from which the identity and principals should be listed. With this option, `--verbose` is redundant. `--verbose`:: If set to `true`, returns a list including the identity, principals, and security name. The default is `false`. -`--target`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. [[operands]] == Operands diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-http-lb-configs.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-http-lb-configs.adoc deleted file mode 100644 index 79558c2f0..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-http-lb-configs.adoc +++ /dev/null @@ -1,84 +0,0 @@ -[[list-http-lb-configs]] -= list-http-lb-configs - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Lists load balancer configurations. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] list-http-lb-configs [--help] -[target] ----- - -[[description]] -== Description - -The `list-http-lb-configs` subcommand lists the load balancer configurations. List them all or list them by the cluster or server instance they reference. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. - -[[operands]] -== Operands - -target:: - Lists the load balancers by target. Valid values are: + - * cluster_name - The name of a target cluster. - * instance_name - The name of a target server instance. - -[[examples]] -== Examples - -[[example-1]] - -*Example 1Listing Load Balancer Configurations Without a Target* - -This example lists all load balancer configurations defined for all Payara Server clusters and instances. - -[source,shell] ----- -asadmin> list-http-lb-configs - -mycluster-http-lb-config -serverinstlb -Command list-http-lb-configs executed successfully. ----- - -[[example-2]] - -*Example 2 Listing Load Balancer Configurations for a Specific Target* - -This example lists the load balancer configuration defined for a cluster named `mycluster`. - -[source,shell] ----- -asadmin> list-http-lb-configs mycluster - -mycluster-http-lb-config -Command list-http-lb-configs executed successfully. ----- - -[[exit-status]] -== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb-config.adoc#create-http-lb-config[`create-http-lb-config`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb-config.adoc#delete-http-lb-config[`delete-http-lb-config`] diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-http-lbs.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-http-lbs.adoc deleted file mode 100644 index 82343c20f..000000000 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/list-http-lbs.adoc +++ /dev/null @@ -1,90 +0,0 @@ -[[list-http-lbs]] -= list-http-lbs - -IMPORTANT: This subcommand has been retained from Oracle GlassFish's original integration with external load balancers, but it has no proper integration functionality in Payara Server. Hence, it is not intended to be used in any way. + -The documentation in this page may not be accurate. - -Lists load balancers. - -[[synopsis]] -== Synopsis - -[source,shell] ----- -asadmin [asadmin-options] list-http-lbs [--help] -[--long={false|true}] -[--output output] -[--header={false|true}] -[name] ----- - -[[description]] -== Description - -Use the `list-http-lbs` subcommand to list physical load balancers. - -[[options]] -== Options - -asadmin-options:: - Options for the `asadmin` utility. For information about these options, see the xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] help page. -`--help`:: -`-?`:: - Displays the help text for the subcommand. -`--long`:: -`-l`:: - Displays detailed information about each load balancer. The default value is `false.` -`--output`:: -`-o`:: - Displays specific details about each load balancer. Use a comma-separated list to specify the details you want to display and their order. For example, `list-http-lbs --output name,device-host,device-port`. The values are case-insensitive. + - Possible values are as follows: + - `device-host`;; - Displays the device host or the IP address of the load balancing device. This host or IP is where the physical load balancer resides. - `name`;; - Displays the name of the load balancer. - `auto-apply-enabled`;; - Displays whether the Auto Apply feature is enabled. - `lb-config-name`;; - Displays the name of the load balancer configuration. - `device-port`;; - Displays the port used to communicate with the load balancing device. -`--header`:: -`-h`:: - Specifies whether column headings are displayed when the `--long` option is used. The default value is `true`. To suppress the headings, set the `--header` option to `false`. - -[[operands]] -== Operands - -name:: - The name of the load balancer for which you want to display details. - -[[examples]] -== Examples - -[[example-1]] - -*Example 1 Listing Physical Load Balancers for a Domain* - -This example lists all physical load balancers defined for a domain. - -[source,shell] ----- -asadmin> list-http-lbs -lb1 -lb2 -Command list-http-lbs executed successfully. ----- - -[[exit-status]] -=== Exit Status - -0:: - subcommand executed successfully -1:: - error in executing the subcommand - -*See Also* - -* xref:Technical Documentation/Payara Server Documentation/Command Reference/asadmin.adoc#asadmin-1m[`asadmin`] -* xref:Technical Documentation/Payara Server Documentation/Command Reference/create-http-lb.adoc#create-http-lb[`create-http-lb`], -* xref:Technical Documentation/Payara Server Documentation/Command Reference/delete-http-lb.adoc#delete-http-lb[`delete-http-lb`] diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/monitor.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/monitor.adoc index cb499e77d..7b31447fe 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/monitor.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/monitor.adoc @@ -10,7 +10,6 @@ Displays monitoring data for commonly used components and services. ---- asadmin [asadmin-options] monitor [--help] --type type -[--filename filename] [--interval interval] [--filter filter] instance-name @@ -86,9 +85,6 @@ asadmin-options:: The maximum number of Java servlets that were active at any time simultaneously. `tslc`:: The total number of Java servlets that have been loaded. -`--filename`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does - not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. `--interval`:: The interval in seconds before capturing monitoring attributes. The interval must be greater than 0. The monitoring attributes are displayed on `stdout` until you type Control-C or `q`. The default value is 30. diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/set-jmx-monitoring-configuration.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/set-jmx-monitoring-configuration.adoc index c2b406d06..29515b561 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/set-jmx-monitoring-configuration.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/set-jmx-monitoring-configuration.adoc @@ -12,7 +12,6 @@ asadmin [asadmin-options] set-jmx-monitoring-configuration [--help] [--target target] [--enabled={false|true}] -[--amx={false|true}] [--logFrequency frequency] [--logFrequencyUnit={DAYS|HOURS|MINUTES|SECONDS|MILLISECONDS}] [--addAttribute="attributes"] @@ -47,8 +46,6 @@ Applies to a specified server instance. Defaults to `false`. Enables or disables the JMX monitoring service `--dynamic`:: Defaults to `false`. When set to `true`, applies the changes without a server restart. -`--amx`:: -Defaults to `false`. Whether to enable or disable the AMX subsystem on boot. `--addAttribute`:: Provides a way to add a new **MBean** attribute to monitor using the service. + diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/set-monitoring-service-configuration.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/set-monitoring-service-configuration.adoc index 576179896..a16f0dbeb 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/set-monitoring-service-configuration.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/set-monitoring-service-configuration.adoc @@ -13,7 +13,6 @@ asadmin [asadmin-options] set-monitoring-service-configuration [--target target] [--enabled={false|true}] [--mbeansenabled={false|true}] -[--amxenabled={false|true}] [--dtraceenabled={false|true}] ---- @@ -42,8 +41,6 @@ Applies to a specified server instance. Defaults to `false`. Enables or disables the monitoring service `--mbeansenabled`:: Defaults to `false`. Whether to enable or disable MBean monitoring. -`--amxenabled`:: -Defaults to `false`. Whether to enable or disable the AMX subsystem on boot. `--dtraceenabled`:: Defaults to `false`. Whether to enable or disable the DTrace monitoring. diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/start-cluster.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/start-cluster.adoc index c65646cb7..1b4c9d2d7 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/start-cluster.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/start-cluster.adoc @@ -9,7 +9,6 @@ Starts a cluster. [source,shell] ---- asadmin [asadmin-options] start-cluster [--help] -[--autohadboverride={true|false}] [--verbose={false|true}] cluster-name ---- @@ -37,10 +36,6 @@ asadmin-options:: `-?`:: Displays the help text for the subcommand. -`--autohadboverride`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does - not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - `--verbose`:: Specifies whether additional status information is displayed when the cluster is started. + diff --git a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/stop-cluster.adoc b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/stop-cluster.adoc index 42b380a30..650962cf8 100644 --- a/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/stop-cluster.adoc +++ b/docs/modules/ROOT/pages/Technical Documentation/Payara Server Documentation/Command Reference/stop-cluster.adoc @@ -11,7 +11,6 @@ Stops a Payara Server cluster. asadmin [asadmin-options] stop-cluster [--help] [--verbose={false|true}] [--kill={false|true}] -[--autohadboverride={true|false}] cluster-name ---- @@ -51,10 +50,6 @@ Possible values are as follows: `true`;; Each instance is killed. The subcommand uses functionality of the operating system to terminate each instance process. -`--autohadboverride`:: - Do not specify this option. This option is retained for compatibility with earlier releases. If you specify this option, a syntax error does - not occur. Instead, the subcommand runs successfully and displays a warning message that the option is ignored. - [[operands]] == Operands