GraphiteReporter

Global Operations

Resource path:

/global-config/services/monitoring/graphite

Resource version: 1.0

create

Usage

am> create GraphiteReporter --global --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "host" : {
      "title" : "Hostname",
      "description" : "The hostname of the Graphite server to which metrics should be published.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "port" : {
      "title" : "Port",
      "description" : "The port of the Graphite server to which metrics should be published.",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "frequency" : {
      "title" : "Frequency",
      "description" : "The frequency (in seconds) at which metrics should be published.",
      "propertyOrder" : 300,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    }
  }
}

delete

Usage

am> delete GraphiteReporter --global --id id

Parameters

--id

The unique identifier for the resource.

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action GraphiteReporter --global --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action GraphiteReporter --global --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action GraphiteReporter --global --actionName nextdescendents

query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query GraphiteReporter --global --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read GraphiteReporter --global --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update GraphiteReporter --global --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "host" : {
      "title" : "Hostname",
      "description" : "The hostname of the Graphite server to which metrics should be published.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "port" : {
      "title" : "Port",
      "description" : "The port of the Graphite server to which metrics should be published.",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "frequency" : {
      "title" : "Frequency",
      "description" : "The frequency (in seconds) at which metrics should be published.",
      "propertyOrder" : 300,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    }
  }
}