icinga delete-object
deletes object
Description
deletes object
Synopsis
icinga delete-object
[--site <site>]
[--cluster <cluster>]
--name <name>
--object_type <object_type>
[--cascade <cascade>]
Arguments
site
- (string)
Site where this command will be executed
Example: --site "site-1"
Default: input.site
Attributes: optional
cluster
- (string)
Name of Icinga cluster
Example: --cluster "icinga-default"
Default: icinga-default
Attributes: optional
name
- (string)
Name of the object. Must be unique on a per-host basis
Example: --name "checkcommand1"
Default: _None_
Attributes: required
object_type
- (string)
Type of object
Example: --object_type "hosts, services"
Default: _None_
Attributes: required
cascade
- (boolean)
Delete objects depending on the deleted objects (e.g. services on a host).
Example: --cascade "cascade-1"
Default: _None_
Attributes: optional
Examples
icinga delete-object --name "checkcommand1" --object_type "hosts, services" --cascade "cascade-1"
Access Control
To use this command, you need access to the following:
Field | Value |
---|---|
Action | "delete" |
Service Type | "icinga" |
Service Instance | cluster |
Namespace | |
Object Type | "host" |
Object ID | name |
Please see Access Control for details.