vcf_vcfops_webhook

Execution module for VCF Operations outbound webhooks and notification rules.

saltext.vcf.modules.vcf_vcfops_webhook.list_(page=0, page_size=1000, profile=None)

List every configured outbound webhook / notification instance.

CLI Example:

salt '*' vcf_vcfops_webhook.list_

saltext.vcf.modules.vcf_vcfops_webhook.get(instance_id, profile=None)

Return the outbound instance with id instance_id.

CLI Example:

salt '*' vcf_vcfops_webhook.get <instance-id>

saltext.vcf.modules.vcf_vcfops_webhook.get_or_none(instance_id, profile=None)

Like get() but returns None on a 404.

CLI Example:

salt '*' vcf_vcfops_webhook.get_or_none <instance-id>

saltext.vcf.modules.vcf_vcfops_webhook.create(instance_spec, profile=None)

Create an outbound webhook / notification instance.

CLI Example:

salt '*' vcf_vcfops_webhook.create '{"name": "pd", "pluginTypeId": "RestPlugin", ...}'

saltext.vcf.modules.vcf_vcfops_webhook.update(instance_id, instance_spec, profile=None)

Replace an outbound instance.

CLI Example:

salt '*' vcf_vcfops_webhook.update <instance-id> '{...}'

saltext.vcf.modules.vcf_vcfops_webhook.delete(instance_id, profile=None)

Delete an outbound instance by id.

CLI Example:

salt '*' vcf_vcfops_webhook.delete <instance-id>

saltext.vcf.modules.vcf_vcfops_webhook.list_rules(page=0, page_size=1000, profile=None)

List every notification rule.

CLI Example:

salt '*' vcf_vcfops_webhook.list_rules

saltext.vcf.modules.vcf_vcfops_webhook.get_rule(rule_id, profile=None)

Return the notification rule with id rule_id.

CLI Example:

salt '*' vcf_vcfops_webhook.get_rule <rule-id>

saltext.vcf.modules.vcf_vcfops_webhook.get_rule_or_none(rule_id, profile=None)

Like get_rule() but returns None on a 404.

CLI Example:

salt '*' vcf_vcfops_webhook.get_rule_or_none <rule-id>

saltext.vcf.modules.vcf_vcfops_webhook.create_rule(rule_spec, profile=None)

Create a notification rule binding an alert to an outbound instance.

CLI Example:

salt '*' vcf_vcfops_webhook.create_rule '{"name": "...", "pluginId": "...", ...}'

saltext.vcf.modules.vcf_vcfops_webhook.update_rule(rule_id, rule_spec, profile=None)

Replace a notification rule.

CLI Example:

salt '*' vcf_vcfops_webhook.update_rule <rule-id> '{...}'

saltext.vcf.modules.vcf_vcfops_webhook.delete_rule(rule_id, profile=None)

Delete a notification rule by id.

CLI Example:

salt '*' vcf_vcfops_webhook.delete_rule <rule-id>