class bluecat.tag.TagGroup(api, api_entity)
Bases: bluecat.entity.Entity
Wraps the BAM TagGroup Entity type.
| Parameters | Description |
|---|---|
| api | API instance used by the entity to communicate with BAM. |
| api_entity | the returned by the BAM API. |
add_tag(name, properties=None)
Creates a tag and return its entity id (not per Configuration).
| Parameters | 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.
| Parameters | 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’
Returns: A iterator of Tag objects listed under the TagGroup object.