TagGroup class - Platform - BlueCat Gateway - 18.2.1

Gateway Administration Guide

prodname
BlueCat Gateway
version_custom
18.2.1

The Tag class wraps the BAM Tag Entity type.

classtag.TagGroup(api, api_entity)

Bases: bluecat.entity.Entity

Instantiate a TagGroup.

Parameter Description
api API instance used by the entity to communicate with BAM.
api_entity The SOAP entity returned by the BAM API.

add_tag(name, properties=None)

Creates a tag and return its entity id (not per Configuration).

Parameter Description
name Name of tag to be created.
properties Optional properties, including user-defined fields.

Returns: Object ID of created tag.

get_tag_by_name(name)

Searches a Tag by name.

Parameter Description
name Name of the Tag.

Returns: A Tag object with the specified name.

get_tags()

Using Entity.get_children_of_type to get children of type ‘Tag’.

Parameter Description
get_children_of_type To get children of type ‘Tag’.

Returns: An iterator of Tag objects listed under the TagGroup object.