Chapter 11. Grouping Load-balancing service objects by using tags

Procedure

1. Confirm that the system OS_CLOUD variable is set for your cloud:

   $ echo $OS_CLOUD
   my_cloud

   Reset the variable if necessary:

   $ export OS_CLOUD=my_other_cloud

   As an alternative, you can specify the cloud name by adding the --os-cloud <cloud_name> option each time you run an openstack command.

2. Add a tag to a load-balancing object when you create it by using the --tag <tag> option with the appropriate create command for the object:

   Note

   A tag can be any valid Unicode string with a maximum length of 255 characters.

   Example - creating and tagging a load balancer

   In this example a load balancer, lb1, is created with two tags, Finance and Sales:

   $ openstack loadbalancer create --name lb1 \
   --vip-subnet-id public_subnet --tag Finance --tag Sales --wait

   Note

   Load-balancing service objects can have one or more tags. Repeat the --tag <tag> option for each additional tag that you want to add.

   Example - creating and tagging a listener

   In this example a listener, listener1, is created with a tag, Sales:

   $ openstack loadbalancer listener create --name listener1 --protocol HTTP --protocol-port 80 --tag Sales lb1 --wait

   Example - creating and tagging a pool

   In this example a pool, pool1, is created with a tag, Sales:

   $ openstack loadbalancer pool create --name pool1 \
   --lb-algorithm ROUND_ROBIN --listener listener1 \
   --protocol HTTP --tag Sales --wait

   Example - creating a member in a pool and tagging it

   In this example a member, 192.0.2.10, is created in pool1 with a tag, Sales:

   $ openstack loadbalancer member create --name member1 \
   --subnet-id private_subnet --address 192.0.2.10 --protocol-port 80 \
   --tag Sales pool1 --wait

   Example - creating and tagging a health monitor

   In this example a health monitor, healthmon1, is created with a tag, Sales:

   $ openstack loadbalancer healthmonitor create --name healthmon1 \
   --delay 15 --max-retries 4 --timeout 10 --type HTTP --url-path / \
   --tag Sales pool1 --wait

   Example - creating and tagging an L7 policy

   In this example an L7 policy, policy1, is created with a tag, Sales:

   $ openstack loadbalancer l7policy create --action REDIRECT_PREFIX \
   --redirect-prefix https://www.example.com/ \
   --name policy1 http_listener --tag Sales --wait

   Example - creating and tagging an L7 rule

   In this example an L7 rule, rule1, is created with a tag, Sales:

   $ openstack loadbalancer l7rule create --compare-type STARTS_WITH \
   --type PATH --value / --tag Sales policy1 --wait

Procedure

1. Confirm that the system OS_CLOUD variable is set for your cloud:

   $ echo $OS_CLOUD
   my_cloud

   Reset the variable if necessary:

   $ export OS_CLOUD=my_other_cloud

   As an alternative, you can specify the cloud name by adding the --os-cloud <cloud_name> option each time you run an openstack command.

2. Do one of the following:

   • Add a tag to a pre-existing load-balancing object by using the --tag <tag> option with the appropriate set command for the object:

     • openstack loadbalancer set --tag <tag> <load_balancer_name_or_ID>
     • openstack loadbalancer listener set --tag <tag> <listener_name_or_ID>
     • openstack loadbalancer pool set --tag <tag> <pool_name_or_ID>
     • openstack loadbalancer member set --tag <tag> <pool_name_or_ID> <member_name_or_ID>
     • openstack loadbalancer healthmonitor set --tag <tag> <healthmon_name_or_ID>
     • openstack loadbalancer l7policy set --tag <tag> <l7policy_name_or_ID>

     • openstack loadbalancer l7rule set --tag <tag> <l7policy_name_or_ID> <l7rule_ID>

       Note

       A tag can be any valid Unicode string with a maximum length of 255 characters.

       Example

       In this example the tags, Finance and Sales, are added to the load balancer, lb1:

       $ openstack loadbalancer set --tag Finance --tag Sales lb1

       Note

       Load-balancing service objects can have one or more tags. Repeat the --tag <tag> option for each additional tag that you want to add.

   • Remove a tag from a pre-existing load-balancing object by using the --tag <tag> option with the appropriate unset command for the object:

     • openstack loadbalancer unset --tag <tag> <load_balancer_name_or_ID>
     • openstack loadbalancer listener unset --tag <tag> <listener_name_or_ID>
     • openstack loadbalancer pool unset --tag <tag> <pool_name_or_ID>
     • openstack loadbalancer member unset --tag <tag> <pool_name_or_ID> <member_name_or_ID>
     • openstack loadbalancer healthmonitor unset --tag <tag> <healthmon_name_or_ID>
     • openstack loadbalancer l7policy unset --tag <tag> <policy_name_or_ID>

     • openstack loadbalancer l7rule unset --tag <tag> <policy_name_or_ID> <l7rule_ID>

       Example

       In this example, the tag, Sales, is removed from the load balancer, lb1:

       $ openstack loadbalancer unset --tag Sales lb1

   • Remove all tags from a pre-existing load-balancing object by using the --no-tag option with the appropriate set command for the object:

     • openstack loadbalancer set --no-tag <load_balancer_name_or_ID>
     • openstack loadbalancer listener set --no-tag <listener_name_or_ID>
     • openstack loadbalancer pool set --no-tag <pool_name_or_ID>
     • openstack loadbalancer member set --no-tag <pool_name_or_ID> <member_name_or_ID>
     • openstack loadbalancer healthmonitor set --no-tag <healthmon_name_or_ID>
     • openstack loadbalancer l7policy set --no-tag <l7policy_name_or_ID>

     • openstack loadbalancer l7rule set --no-tag <l7policy_name_or_ID> <l7rule_ID>

       Example

       In this example, all tags are removed from the load balancer, lb1:

       $ openstack loadbalancer set --no-tag lb1

Procedure

1. Confirm that the system OS_CLOUD variable is set for your cloud:

   $ echo $OS_CLOUD
   my_cloud

   Reset the variable if necessary:

   $ export OS_CLOUD=my_other_cloud

   As an alternative, you can specify the cloud name by adding the --os-cloud <cloud_name> option each time you run an openstack command.

2. Filter the objects that you want to list by running the appropriate loadbalancer list command for the objects with one of the tag options:

   Expand

   Table 11.1. Tag options for filtering objects

   In my list, I want to…​	Examples
   include objects that match all specified tags.	$ openstack loadbalancer list --tags Sales,Finance $ openstack loadbalancer listener list --tags Sales,Finance $ openstack loadbalancer l7pool list --tags Sales,Finance $ openstack loadbalancer member list --tags Sales,Finance pool1 $ openstack loadbalancer healthmonitor list --tags Sales,Finance $ openstack loadbalancer l7policy list --tags Sales,Finance $ openstack loadbalancer l7rule list --tags Sales,Finance policy1
   include objects that match one or more specified tags.	$ openstack loadbalancer list --any-tags Sales,Finance $ openstack loadbalancer listener list --any-tags Sales,Finance $ openstack loadbalancer l7pool list --any-tags Sales,Finance $ openstack loadbalancer member list --any-tags Sales,Finance pool1 $ openstack loadbalancer healthmonitor list --any-tags Sales,Finance $ openstack loadbalancer l7policy list --any-tags Sales,Finance $ openstack loadbalancer l7rule list --any-tags Sales,Finance policy1
   exclude objects that match all specified tags.	$ openstack loadbalancer list --not-tags Sales,Finance $ openstack loadbalancer listener list --not-tags Sales,Finance $ openstack loadbalancer l7pool list --not-tags Sales,Finance $ openstack loadbalancer member list --not-tags Sales,Finance pool1 $ openstack loadbalancer healthmonitor list --not-tags Sales,Finance $ openstack loadbalancer l7policy list --not-tags Sales,Finance $ openstack loadbalancer l7rule list --not-tags Sales,Finance policy1
   exclude objects that match one or more specified tags.	$ openstack loadbalancer list --not-any-tags Sales,Finance $ openstack loadbalancer listener list --not-any-tags Sales,Finance $ openstack loadbalancer l7pool list --not-any-tags Sales,Finance $ openstack loadbalancer member list --not-any-tags Sales,Finance pool1 $ openstack loadbalancer healthmonitor list --not-any-tags Sales,Finance $ openstack loadbalancer l7policy list --not-any-tags Sales,Finance $ openstack loadbalancer l7rule list --not-any-tags Sales,Finance policy1

   Show more
   Note

   When specifying more than one tag, separate the tags by using a comma.