Source code for saltext.vcf.modules.vcf_vcfa_action_subscription

"""Execution module for VCF Automation event-broker action subscriptions."""

from saltext.vcf.clients import vcfa_action_subscription as c

__virtualname__ = "vcf_vcfa_action_subscription"


def __virtual__():
    return __virtualname__



[docs]
def list_(profile=None):
    """List all event-broker subscriptions.

    CLI Example:

    .. code-block:: bash

        salt '*' vcf_vcfa_action_subscription.list_
    """
    return c.list_(__opts__, profile=profile)




[docs]
def get(subscription_id, profile=None):
    """Get one subscription by id."""
    return c.get(__opts__, subscription_id, profile=profile)




[docs]
def get_or_none(subscription_id, profile=None):
    """Get one subscription by id, or ``None`` on 404."""
    return c.get_or_none(__opts__, subscription_id, profile=profile)




[docs]
def create(spec, profile=None):
    """Create a subscription."""
    return c.create(__opts__, spec, profile=profile)




[docs]
def update(subscription_id, spec, profile=None):
    """Update a subscription."""
    return c.update(__opts__, subscription_id, spec, profile=profile)




[docs]
def delete(subscription_id, profile=None):
    """Delete a subscription."""
    return c.delete(__opts__, subscription_id, profile=profile)




[docs]
def list_event_topics(profile=None):
    """List every event topic the broker exposes."""
    return c.list_event_topics(__opts__, profile=profile)