blob: 9a2b8af9de97b253c3c1eaa2f7a127e70b085b89 [file] [log] [blame]
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +05301type=page
2status=published
3title=delete-http-lb-ref
4next=delete-http-listener.html
5prev=delete-http-lb-config.html
6~~~~~~
David Matějček17fd4612021-12-18 21:14:28 +01007
David Matějčekdbccabf2021-12-20 14:06:31 +01008= delete-http-lb-ref
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +05309
10[[delete-http-lb-ref-1]][[GSRFM00081]][[delete-http-lb-ref]]
11
David Matějčekdbccabf2021-12-20 14:06:31 +010012== delete-http-lb-ref
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053013
David Matějček17fd4612021-12-18 21:14:28 +010014Deletes the cluster or server instance from a load balancer
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053015
16[[sthref723]]
17
David Matějček17fd4612021-12-18 21:14:28 +010018=== Synopsis
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053019
David Matějček17fd4612021-12-18 21:14:28 +010020[source]
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053021----
David Matějček17fd4612021-12-18 21:14:28 +010022asadmin [asadmin-options] delete-http-lb-ref [--help]
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053023--config config_name | --lbname load_balancer_name
24[--force=false] target
25----
26
27[[sthref724]]
28
David Matějček17fd4612021-12-18 21:14:28 +010029=== Description
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053030
31Use the `delete-http-lb-ref` subcommand to remove a reference to a
32cluster or standalone server instance from a load balancer configuration
33or load balancer. So that you do not interrupt user requests, make sure
34the standalone server instance or all server instances in the cluster
35are disabled before you remove them from the load balancer
36configuration. If the `force` option is set to true, the references are
37deleted even if server instances or clusters are enabled.
38
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053039[NOTE]
David Matějček17fd4612021-12-18 21:14:28 +010040====
David Matějček6c58c142021-12-20 20:22:31 +010041This subcommand is only applicable to {productName}. This
42subcommand is not applicable to {productName}.
David Matějček17fd4612021-12-18 21:14:28 +010043====
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053044
45[[sthref725]]
46
David Matějček17fd4612021-12-18 21:14:28 +010047=== Options
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053048
49asadmin-options::
50 Options for the `asadmin` utility. For information about these
51 options, see the link:asadmin.html#asadmin-1m[`asadmin`(1M)] help page.
52`--help`::
53`-?`::
54 Displays the help text for the subcommand.
55`--config`::
56 Specifies which load balancer configuration to delete cluster and
57 server instance references from. +
58 Specify either a load balancer configuration or a load balancer.
59 Specifying both results in an error.
60`--lbname`::
61 Specifies the load balancer to delete cluster and server instance
62 references from. +
63 Specify either a load balancer configuration or a load balancer.
64 Specifying both results in an error.
65`--force`::
66 If `force` is set to true, then the references are deleted even if
67 there are currently enabled applications or instances. The default is
68 false.
69
70[[sthref726]]
71
David Matějček17fd4612021-12-18 21:14:28 +010072=== Operands
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053073
74target::
75 Specifies which cluster or instance to remove from the load balancer.
David Matějček17fd4612021-12-18 21:14:28 +010076 Valid values are:
77
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053078 * cluster_name- The name of a target cluster.
79 * instance_name- The name of a target server instance.
80
81[[sthref727]]
82
David Matějček17fd4612021-12-18 21:14:28 +010083=== Examples
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053084
85[[GSRFM550]][[sthref728]]
86
David Matějček17fd4612021-12-18 21:14:28 +010087==== Example 1   Deleting a Cluster Reference from a Load Balancer
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053088Configuration
89
90This example deletes the reference to cluster named `cluster2` from a
91load balancer configuration named `mycluster-http-lb-config`.
92
David Matějček17fd4612021-12-18 21:14:28 +010093[source]
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053094----
David Matějček17fd4612021-12-18 21:14:28 +010095asadmin> delete-http-lb-ref --config mycluster-http-lb-config cluster2
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +053096
97Command delete-http-lb-ref executed successfully.
98----
99
100[[sthref729]]
101
David Matějček17fd4612021-12-18 21:14:28 +0100102=== Exit Status
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530103
1040::
105 subcommand executed successfully
1061::
107 error in executing the subcommand
108
109[[sthref730]]
110
David Matějček17fd4612021-12-18 21:14:28 +0100111=== See Also
Vinay Vishal7c4c4fc2019-01-28 12:01:04 +0530112
113link:asadmin.html#asadmin-1m[`asadmin`(1M)]
114
115link:create-http-lb-ref.html#create-http-lb-ref-1[`create-http-lb-ref`(1)],
116link:disable-http-lb-server.html#disable-http-lb-server-1[`disable-http-lb-server`(1)]
117
118