TagGroup class - Platform - BlueCat Gateway - 19.8.1

Gateway Administration Guide

English (United States)
Product name
BlueCat Gateway

The Tag class wraps the BAM Tag Entity type.

class tag.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 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.


Searches a Tag by name.

Parameter Description
name Name of the Tag.

Returns: A Tag object with the specified name.


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.