pillar interface — VMware Salt API

pillar interface

The LoadedMod class allows for the module loaded onto the sub to return custom sequencing, for instance it can be iterated over to return all functions

delete_pillar(pillar_uuid: <class 'uuid.UUID'>)

Delete pillar for the given UUID.

Parameters

pillar_uuid:	UUID of pillar to delete.

get_pillar_access(pillar_uuid: <class 'uuid.UUID'>)

Returns: <class 'dict'>

Get the access metadata for a pillar entry.

Parameters

pillar_uuid:	Retrieve metadata for pillar matching this UUID.

get_pillars(pillar_uuid: uuid.UUID | None, name: str | None, sort_by: str | None, reverse: bool | None, limit: int | None = 50, page: int | None)

Returns: <class 'dict'>

Get the data for the given pillar. For more information on pillar data, see the VMware Salt documentation on Broadcom's TechDocs.

Parameters

param pillar_uuid:	UUID of the pillar structure desired.
param name:	name for this particular pillar entry

The return payload is a dict with the following elements:

{
    'count': 100,     # total job count
    'limit': 50,  # results count
    'results': [...]  # jobs
}

save_pillar(pillar: <class 'dict'>, pillar_type: <class 'str'>, pillar_uuid: uuid.UUID | None, name: str | None, desc: str | None)

Returns: <class 'str'>

Set data in the requested pillar. For more information on pillar data, see the VMware Salt documentation on Broadcom's TechDocs.

Parameters

pillar:	Data structure to save for this pillar.
pillar_type:	Type of pillar
pillar_uuid:	UUID for pillar--if blank a new one will be generated
name:	Name for this particular pillar entry
desc:	Text describing this pillar entry.

save_pillar_access(pillar_uuid: <class 'uuid.UUID'>, access_payload: <class 'dict'>)

Save the access metadata for a target group.

Parameters

pillar_uuid:	Save metadata for pillar matching this UUID.
access_payload:	Dictionary containing role names as keys and a list of allowed access types as values