update-remote-write-config¶

Description¶

Updates remote storage configuration.

Synopsis¶

  update-remote-write-config
--remote-write-config <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--remote-write-config (object)

Remote write storage configuration request for update

address -> (string)

Address of the remote storage

authMethod -> (string)

Authentication method of the remote storage

enabled -> (boolean)

Enabled state of the remote storage config

id -> (string)

UUID of the remote storage configuration

name -> (string)

Name of the remote storage configuration

scope -> (object)

Remote write storage configuration scope

environmentCrn -> (string)

Environment CRN filter for the scope. Empty means no filtering

type -> (string)

The type of this remote storage config. Allowed values: all | controlplane | environments

authHeader -> (object)

Authorization header configuration

credentials -> (string)

Authorization header credentials

shouldUpdateCredentialsField -> (boolean)

Returns true if the credentials field was changed and should be updated

type -> (string)

Authorization header type

basicAuth -> (object)

Basic auth configuration

username -> (string)

Username for the remote storage configuration

shouldUpdatePasswordField -> (boolean)

Returns true if the password field was changed and should be updated

password -> (string)

Password for the remote storage config

customHeaders -> (map)

Additional custom HTTP header key-value pairs that are sent along with each remote write request.

key -> (string)

value -> (string)

integrationConfig -> (object)

The configuration for public cloud metric integration

requestSignerCertificate -> (object)

The configuration for public cloud metric integration

cdpAccessKeyId -> (string)

The key id of the public cloud certificate

privateKey -> (string)

The key information of the certificate

writeRelabelConfigs -> (string)

Relabeling and filtering rules to be applied to the remote write config

tls -> (object)

Tls configuration

insecureSkipVerify -> (boolean)

Skip tls verification

serverName -> (string)

Tls ServerName extension to indicate the name of the server.

clientCertificate -> (string)

Certificate for client cert authentication to the server

clientKey -> (string)

Key for client cert authentication to the server

shouldUpdateClientKeyField -> (boolean)

Returns true if the ClientKey field was changed and should be updated

Shorthand Syntax:

address=string,authMethod=string,enabled=boolean,id=string,name=string,scope={environmentCrn=string,type=string},authHeader={credentials=string,shouldUpdateCredentialsField=boolean,type=string},basicAuth={username=string,shouldUpdatePasswordField=boolean,password=string},customHeaders={KeyName1=string,KeyName2=string},integrationConfig={requestSignerCertificate={cdpAccessKeyId=string,privateKey=string}},writeRelabelConfigs=string,tls={insecureSkipVerify=boolean,serverName=string,clientCertificate=string,clientKey=string,shouldUpdateClientKeyField=boolean}

JSON Syntax:

{
  "address": "string",
  "authMethod": "string",
  "enabled": true|false,
  "id": "string",
  "name": "string",
  "scope": {
    "environmentCrn": "string",
    "type": "string"
  },
  "authHeader": {
    "credentials": "string",
    "shouldUpdateCredentialsField": true|false,
    "type": "string"
  },
  "basicAuth": {
    "username": "string",
    "shouldUpdatePasswordField": true|false,
    "password": "string"
  },
  "customHeaders": {"string": "string"
    ...},
  "integrationConfig": {
    "requestSignerCertificate": {
      "cdpAccessKeyId": "string",
      "privateKey": "string"
    }
  },
  "writeRelabelConfigs": "string",
  "tls": {
    "insecureSkipVerify": true|false,
    "serverName": "string",
    "clientCertificate": "string",
    "clientKey": "string",
    "shouldUpdateClientKeyField": true|false
  }
}

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

remoteWriteConfig -> (object)

Remote write storage configuration

address -> (string)

Address of the remote storage

authMethod -> (string)

Authentication method of the remote storage

enabled -> (boolean)

Enabled state of the remote storage config

id -> (string)

UUID of the remote storage configuration

name -> (string)

Name of the remote storage configuration

accountId -> (string)

Account ID which the remote storage configuration belongs to

authHeader -> (object)

Authorization header configuration response

type -> (string)

Authorization header type

basicAuth -> (object)

Basic auth configuration response

username -> (string)

Username for the remote storage configuration

customHeaders -> (map)

Additional custom HTTP header key-value pairs that are sent along with each remote write request.

key -> (string)

value -> (string)

scope -> (object)

Remote write storage configuration scope for response

environmentCrn -> (string)

Environment CRN filter for the scope. Empty means no filtering

type -> (string)

The type of this remote storage configuration. Allowed values: all | controlplane | environments

integrationConfig -> (object)

The configuration for public cloud metric integration

requestSignerCertificate -> (object)

The configuration for public cloud metric integration

cdpAccessKeyId -> (string)

The key id of the public cloud certificate

privateKey -> (string)

The key information of the certificate

writeRelabelConfigs -> (string)

Relabeling and filtering rules to be applied to the remote write config

tls -> (object)

Tls configuration for response

insecureSkipVerify -> (boolean)

Skip tls verification

isClientKeyFieldEmpty -> (boolean)

Returns true if the ClientKey field is empty

serverName -> (string)

Tls ServerName extension to indicate the name of the server.

clientCertificate -> (string)

Certificate for client cert authentication to the server

Form Factors¶

private