Skip to content

probes 0.0.0

Title: probes 0.0.0

Type object or string
Required No

Description: Json schema representing the probes configuration fields and values

Restrictions
Must match regular expression \$\{.*\} Test
1. [Optional] Property probes 0.0.0 > Probes
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | --------------------------------- | ----------- | | [Probes item 0](#Probes_items_i0) | - | ### 1.1. probes 0.0.0 > Probes > Probes item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > Probe
| | | | ------------------------- | ---------------- | | **Type** | `combining` | | **Required** | No | | **Additional properties** | Any type allowed |
| Any of(Option) | | ----------------------------------------- | | [item 0](#Probes_items_i0_Probe_anyOf_i0) | | [item 1](#Probes_items_i0_Probe_anyOf_i1) |
##### 1.1.1.1. Property `probes 0.0.0 > Probes > Probes item 0 > Probe > anyOf > item 0` | | | | ------------ | ------------------ | | **Type** | `enum (of string)` | | **Required** | No | Must be one of: * "CreateRabbitMqBindings" * "CreateRabbitMqExchanges" * "CreateRabbitMqQueues" * "CreateRabbitMqUsers" * "CreateRabbitMqVirtualHosts" * "CreateS3Bucket" * "DeleteElasticIndices" * "DeleteRabbitMqBindings" * "DeleteRabbitMqExchanges" * "DeleteRabbitMqPermissions" * "DeleteRabbitMqQueues" * "DeleteRabbitMqUsers" * "DeleteRabbitMqVirtualHosts" * "DeleteS3Bucket" * "DownloadRabbitMqDefinitions" * "DropMongoDbCollection" * "EmptyElasticIndices" * "EmptyMongoDbCollection" * "EmptyRedisByChunks" * "EmptyS3Bucket" * "ExecuteRedisCommand" * "ExecuteRedisCommands" * "FlushAllRedis" * "FlushDbRedis" * "MsSqlDataBaseTablesTruncate" * "OracleSqlDataBaseTablesTruncate" * "OsChangeDeploymentEnvVars" * "OsChangeStatefulSetEnvVars" * "OsEditYamlConfigMap" * "OsExecuteCommandsInContainers" * "OsRestartPods" * "OsScaleDeploymentPods" * "OsScaleStatefulSetPods" * "OsUpdateDeploymentImage" * "OsUpdateDeploymentResources" * "OsUpdateStatefulSetImage" * "OsUpdateStatefulSetResources" * "PostgreSqlDataBaseTablesTruncate" * "PurgeRabbitMqQueues" * "UploadRabbitMqDefinitions" * "UpsertRabbitMqPermissions"
##### 1.1.1.2. Property `probes 0.0.0 > Probes > Probes item 0 > Probe > anyOf > item 1` | | | | ------------------------- | ---------------- | | **Type** | `object` | | **Required** | No | | **Additional properties** | Any type allowed |
1.1.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration
| | | | ------------ | ----------- | | **Type** | `combining` | | **Required** | No |
| Any of(Option) | | --------------------------------------------------------------------------------- | | [item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i0) | | [CreateRabbitMqBindings](#Probes_items_i0_ProbeConfiguration_anyOf_i1) | | [CreateRabbitMqExchanges](#Probes_items_i0_ProbeConfiguration_anyOf_i2) | | [CreateRabbitMqQueues](#Probes_items_i0_ProbeConfiguration_anyOf_i3) | | [CreateRabbitMqUsers](#Probes_items_i0_ProbeConfiguration_anyOf_i4) | | [CreateRabbitMqVirtualHosts](#Probes_items_i0_ProbeConfiguration_anyOf_i5) | | [CreateS3Bucket](#Probes_items_i0_ProbeConfiguration_anyOf_i6) | | [DeleteElasticIndices](#Probes_items_i0_ProbeConfiguration_anyOf_i7) | | [DeleteRabbitMqBindings](#Probes_items_i0_ProbeConfiguration_anyOf_i8) | | [DeleteRabbitMqExchanges](#Probes_items_i0_ProbeConfiguration_anyOf_i9) | | [DeleteRabbitMqPermissions](#Probes_items_i0_ProbeConfiguration_anyOf_i10) | | [DeleteRabbitMqQueues](#Probes_items_i0_ProbeConfiguration_anyOf_i11) | | [DeleteRabbitMqUsers](#Probes_items_i0_ProbeConfiguration_anyOf_i12) | | [DeleteRabbitMqVirtualHosts](#Probes_items_i0_ProbeConfiguration_anyOf_i13) | | [DeleteS3Bucket](#Probes_items_i0_ProbeConfiguration_anyOf_i14) | | [DownloadRabbitMqDefinitions](#Probes_items_i0_ProbeConfiguration_anyOf_i15) | | [DropMongoDbCollection](#Probes_items_i0_ProbeConfiguration_anyOf_i16) | | [EmptyElasticIndices](#Probes_items_i0_ProbeConfiguration_anyOf_i17) | | [EmptyMongoDbCollection](#Probes_items_i0_ProbeConfiguration_anyOf_i18) | | [EmptyRedisByChunks](#Probes_items_i0_ProbeConfiguration_anyOf_i19) | | [EmptyS3Bucket](#Probes_items_i0_ProbeConfiguration_anyOf_i20) | | [ExecuteRedisCommand](#Probes_items_i0_ProbeConfiguration_anyOf_i21) | | [ExecuteRedisCommands](#Probes_items_i0_ProbeConfiguration_anyOf_i22) | | [FlushAllRedis](#Probes_items_i0_ProbeConfiguration_anyOf_i23) | | [FlushDbRedis](#Probes_items_i0_ProbeConfiguration_anyOf_i24) | | [MsSqlDataBaseTablesTruncate](#Probes_items_i0_ProbeConfiguration_anyOf_i25) | | [OracleSqlDataBaseTablesTruncate](#Probes_items_i0_ProbeConfiguration_anyOf_i26) | | [OsChangeDeploymentEnvVars](#Probes_items_i0_ProbeConfiguration_anyOf_i27) | | [OsChangeStatefulSetEnvVars](#Probes_items_i0_ProbeConfiguration_anyOf_i28) | | [OsEditYamlConfigMap](#Probes_items_i0_ProbeConfiguration_anyOf_i29) | | [OsExecuteCommandsInContainers](#Probes_items_i0_ProbeConfiguration_anyOf_i30) | | [OsRestartPods](#Probes_items_i0_ProbeConfiguration_anyOf_i31) | | [OsScaleDeploymentPods](#Probes_items_i0_ProbeConfiguration_anyOf_i32) | | [OsScaleStatefulSetPods](#Probes_items_i0_ProbeConfiguration_anyOf_i33) | | [OsUpdateDeploymentImage](#Probes_items_i0_ProbeConfiguration_anyOf_i34) | | [OsUpdateDeploymentResources](#Probes_items_i0_ProbeConfiguration_anyOf_i35) | | [OsUpdateStatefulSetImage](#Probes_items_i0_ProbeConfiguration_anyOf_i36) | | [OsUpdateStatefulSetResources](#Probes_items_i0_ProbeConfiguration_anyOf_i37) | | [PostgreSqlDataBaseTablesTruncate](#Probes_items_i0_ProbeConfiguration_anyOf_i38) | | [PurgeRabbitMqQueues](#Probes_items_i0_ProbeConfiguration_anyOf_i39) | | [UploadRabbitMqDefinitions](#Probes_items_i0_ProbeConfiguration_anyOf_i40) | | [UpsertRabbitMqPermissions](#Probes_items_i0_ProbeConfiguration_anyOf_i41) |
##### 1.1.2.1. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > item 0` | | | | ------------------------- | ---------------- | | **Type** | `object` | | **Required** | No | | **Additional properties** | Any type allowed |
##### 1.1.2.2. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings` **Title:** CreateRabbitMqBindings | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.2.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.2.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.2.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.2.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.2.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.2.6. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Bindings
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq bindings | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | --------------------------------------------------------------------------------- | ----------- | | [Bindings item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i1_Bindings_items_i0) | - | ###### 1.1.2.2.6.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Bindings > Bindings item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.2.6.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Bindings > Bindings item 0 > SourceName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the binding's source
1.1.2.2.6.1.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Bindings > Bindings item 0 > DestinationName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the binding's destination
1.1.2.2.6.1.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Bindings > Bindings item 0 > RoutingKey
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** The binding's routing key
1.1.2.2.6.1.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Bindings > Bindings item 0 > Arguments
| | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | **Description:** The binding's arguments | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.2.6.1.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqBindings > Bindings > Bindings item 0 > BindingType
| | | | ------------ | ------------------- | | **Type** | `enum (of string)` | | **Required** | No | | **Default** | `"ExchangeToQueue"` | **Description:** The type of the binding Must be one of: * "ExchangeToQueue" * "ExchangeToExchange" | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.3. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges` **Title:** CreateRabbitMqExchanges | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.3.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.3.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.3.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.3.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.3.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.3.6. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Exchanges
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq exchanges to create | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ----------------------------------------------------------------------------------- | ----------- | | [Exchanges item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i2_Exchanges_items_i0) | - | ###### 1.1.2.3.6.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Exchanges > Exchanges item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.3.6.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Exchanges > Exchanges item 0 > Name
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the exchange
1.1.2.3.6.1.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Exchanges > Exchanges item 0 > Type
| | | | ------------ | ------------------ | | **Type** | `enum (of string)` | | **Required** | No | | **Default** | `"Fanout"` | **Description:** The type of the exchange Must be one of: * "Fanout" * "Topic" * "Direct" * "Headers" * "ConsistentHash" | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.3.6.1.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Exchanges > Exchanges item 0 > Durable
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Should the exchange be durable | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.3.6.1.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Exchanges > Exchanges item 0 > AutoDelete
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Should the exchange be autoDelete | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.3.6.1.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqExchanges > Exchanges > Exchanges item 0 > Arguments
| | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | **Description:** Extra arguments for the exchange | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.4. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues` **Title:** CreateRabbitMqQueues | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.4.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.4.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.4.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.4.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.4.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.4.6. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Queues
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq queues to create | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ----------------------------------------------------------------------------- | ----------- | | [Queues item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i3_Queues_items_i0) | - | ###### 1.1.2.4.6.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Queues > Queues item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.4.6.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Queues > Queues item 0 > Name
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the queue
1.1.2.4.6.1.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Queues > Queues item 0 > Durable
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Should the exchange be durable | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.4.6.1.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Queues > Queues item 0 > Exclusive
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | Yes | | **Default** | `false` | **Description:** Should the queue be exclusive | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.4.6.1.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Queues > Queues item 0 > AutoDelete
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `true` | **Description:** Should the queue be autoDelete | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.4.6.1.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqQueues > Queues > Queues item 0 > Arguments
| | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | **Description:** Extra arguments for the queue | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.5. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers` **Title:** CreateRabbitMqUsers | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.5.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > ManagementScheme
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"http"` | **Description:** Rabbitmq management API scheme
1.1.2.5.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > ManagementPort
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `15672` | **Description:** Rabbitmq management API port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.5.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > AllowInvalidServerCertificates
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Allow invalid TLS certificates when using HTTPS | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.5.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30000` | **Description:** Rabbitmq management API request timeout in milliseconds | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.5.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.5.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.5.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.5.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.5.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.5.10. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Users
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq users to create or update | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | --------------------------------------------------------------------------- | ----------- | | [Users item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i4_Users_items_i0) | - | ###### 1.1.2.5.10.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Users > Users item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.5.10.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Users > Users item 0 > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The rabbitmq user name
1.1.2.5.10.1.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Users > Users item 0 > Password
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional password for the rabbitmq user
1.1.2.5.10.1.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Users > Users item 0 > PasswordHash
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional password hash for the rabbitmq user
1.1.2.5.10.1.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Users > Users item 0 > HashingAlgorithm
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional hashing algorithm for the password hash
1.1.2.5.10.1.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Users > Users item 0 > Tags
| | | | ------------ | ----------------------- | | **Type** | `array, null or string` | | **Required** | No | **Description:** Optional tags assigned to the rabbitmq user | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ---------------------------------------------------------------------------------------- | ----------- | | [Tags item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i4_Users_items_i0_Tags_items_i0) | - | ###### 1.1.2.5.10.1.5.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqUsers > Users > Users item 0 > Tags > Tags item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
##### 1.1.2.6. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts` **Title:** CreateRabbitMqVirtualHosts | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.6.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > ManagementScheme
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"http"` | **Description:** Rabbitmq management API scheme
1.1.2.6.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > ManagementPort
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `15672` | **Description:** Rabbitmq management API port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.6.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > AllowInvalidServerCertificates
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Allow invalid TLS certificates when using HTTPS | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.6.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30000` | **Description:** Rabbitmq management API request timeout in milliseconds | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.6.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.6.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.6.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.6.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.6.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.6.10. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHosts
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq virtual hosts to create or update | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ----------------------------------------------------------------------------------------- | ----------- | | [VirtualHosts item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i5_VirtualHosts_items_i0) | - | ###### 1.1.2.6.10.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHosts > VirtualHosts item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.6.10.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHosts > VirtualHosts item 0 > Name
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the rabbitmq virtual host
1.1.2.6.10.1.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHosts > VirtualHosts item 0 > Description
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional description for the rabbitmq virtual host
1.1.2.6.10.1.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHosts > VirtualHosts item 0 > Tags
| | | | ------------ | ----------------------- | | **Type** | `array, null or string` | | **Required** | No | **Description:** Optional tags for the rabbitmq virtual host | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ----------------------------------------------------------------------------------------------- | ----------- | | [Tags item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i5_VirtualHosts_items_i0_Tags_items_i0) | - | ###### 1.1.2.6.10.1.3.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHosts > VirtualHosts item 0 > Tags > Tags item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.6.10.1.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHosts > VirtualHosts item 0 > DefaultQueueType
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional default queue type for the virtual host
1.1.2.6.10.1.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHosts > VirtualHosts item 0 > ProtectedFromDeletion
| | | | ------------ | ------------------------- | | **Type** | `boolean, null or string` | | **Required** | No | **Description:** Optional deletion protection flag for the virtual host | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.6.10.1.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateRabbitMqVirtualHosts > VirtualHosts > VirtualHosts item 0 > Tracing
| | | | ------------ | ------------------------- | | **Type** | `boolean, null or string` | | **Required** | No | **Description:** Optional tracing flag for the virtual host | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.7. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateS3Bucket` **Title:** CreateS3Bucket | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.7.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateS3Bucket > StorageBucket
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Name of S3 bucket
1.1.2.7.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateS3Bucket > ServiceURL
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | | **Format** | `uri` | **Description:** S3 service url
1.1.2.7.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateS3Bucket > AccessKey
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** S3 account access key
1.1.2.7.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateS3Bucket > SecretKey
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** S3 account secret access key
1.1.2.7.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > CreateS3Bucket > ForcePathStyle
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `true` | **Description:** When true, requests will always use path style addressing | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.8. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteElasticIndices` **Title:** DeleteElasticIndices | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.8.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteElasticIndices > IndexPattern
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The index pattern of the relevant indices
1.1.2.8.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteElasticIndices > Url
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | | **Format** | `uri` | **Description:** The url of the elasticsearch
1.1.2.8.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteElasticIndices > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The username of the elasticsearch
1.1.2.8.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteElasticIndices > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The password of the elasticsearch
1.1.2.8.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteElasticIndices > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Default** | `30000` | **Description:** The timeout in milliseconds on the requests sent to the elastic | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
##### 1.1.2.9. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings` **Title:** DeleteRabbitMqBindings | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.9.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.9.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.9.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.9.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.9.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.9.6. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Bindings
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq bindings | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | --------------------------------------------------------------------------------- | ----------- | | [Bindings item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i8_Bindings_items_i0) | - | ###### 1.1.2.9.6.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Bindings > Bindings item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.9.6.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Bindings > Bindings item 0 > SourceName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the binding's source
1.1.2.9.6.1.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Bindings > Bindings item 0 > DestinationName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the binding's destination
1.1.2.9.6.1.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Bindings > Bindings item 0 > RoutingKey
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** The binding's routing key
1.1.2.9.6.1.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Bindings > Bindings item 0 > Arguments
| | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | **Description:** The binding's arguments | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.9.6.1.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqBindings > Bindings > Bindings item 0 > BindingType
| | | | ------------ | ------------------- | | **Type** | `enum (of string)` | | **Required** | No | | **Default** | `"ExchangeToQueue"` | **Description:** The type of the binding Must be one of: * "ExchangeToQueue" * "ExchangeToExchange" | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.10. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqExchanges` **Title:** DeleteRabbitMqExchanges | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.10.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqExchanges > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.10.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqExchanges > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.10.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqExchanges > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.10.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqExchanges > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.10.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqExchanges > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.10.6. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqExchanges > ExchangeNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** A list of the names of all the exchanges to delete from the given rabbitmq | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------------- | ----------- | | [ExchangeNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i9_ExchangeNames_items_i0) | - | ###### 1.1.2.10.6.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqExchanges > ExchangeNames > ExchangeNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
##### 1.1.2.11. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions` **Title:** DeleteRabbitMqPermissions | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.11.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > ManagementScheme
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"http"` | **Description:** Rabbitmq management API scheme
1.1.2.11.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > ManagementPort
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `15672` | **Description:** Rabbitmq management API port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.11.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > AllowInvalidServerCertificates
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Allow invalid TLS certificates when using HTTPS | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.11.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30000` | **Description:** Rabbitmq management API request timeout in milliseconds | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.11.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.11.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.11.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.11.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.11.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.11.10. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > Permissions
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq permission targets to delete | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ---------------------------------------------------------------------------------------- | ----------- | | [Permissions item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i10_Permissions_items_i0) | - | ###### 1.1.2.11.10.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > Permissions > Permissions item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.11.10.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > Permissions > Permissions item 0 > VirtualHostName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The rabbitmq virtual host name
1.1.2.11.10.1.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqPermissions > Permissions > Permissions item 0 > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The rabbitmq user name
##### 1.1.2.12. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqQueues` **Title:** DeleteRabbitMqQueues | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.12.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqQueues > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.12.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqQueues > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.12.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqQueues > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.12.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqQueues > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.12.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqQueues > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.12.6. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqQueues > QueueNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** A list of the names of all the queues to delete from the given rabbitmq | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | -------------------------------------------------------------------------------------- | ----------- | | [QueueNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i11_QueueNames_items_i0) | - | ###### 1.1.2.12.6.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqQueues > QueueNames > QueueNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
##### 1.1.2.13. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers` **Title:** DeleteRabbitMqUsers | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.13.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > ManagementScheme
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"http"` | **Description:** Rabbitmq management API scheme
1.1.2.13.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > ManagementPort
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `15672` | **Description:** Rabbitmq management API port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.13.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > AllowInvalidServerCertificates
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Allow invalid TLS certificates when using HTTPS | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.13.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30000` | **Description:** Rabbitmq management API request timeout in milliseconds | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.13.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.13.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.13.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.13.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.13.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.13.10. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > Usernames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq users to delete | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------ | ----------- | | [Usernames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i12_Usernames_items_i0) | - | ###### 1.1.2.13.10.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqUsers > Usernames > Usernames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
##### 1.1.2.14. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts` **Title:** DeleteRabbitMqVirtualHosts | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.14.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > ManagementScheme
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"http"` | **Description:** Rabbitmq management API scheme
1.1.2.14.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > ManagementPort
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `15672` | **Description:** Rabbitmq management API port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.14.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > AllowInvalidServerCertificates
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Allow invalid TLS certificates when using HTTPS | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.14.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30000` | **Description:** Rabbitmq management API request timeout in milliseconds | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.14.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.14.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.14.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.14.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.14.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.14.10. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > VirtualHostNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq virtual host names to delete | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | -------------------------------------------------------------------------------------------------- | ----------- | | [VirtualHostNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i13_VirtualHostNames_items_i0) | - | ###### 1.1.2.14.10.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteRabbitMqVirtualHosts > VirtualHostNames > VirtualHostNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
##### 1.1.2.15. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteS3Bucket` **Title:** DeleteS3Bucket | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.15.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteS3Bucket > StorageBucket
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Name of S3 bucket
1.1.2.15.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteS3Bucket > ServiceURL
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | | **Format** | `uri` | **Description:** S3 service url
1.1.2.15.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteS3Bucket > AccessKey
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** S3 account access key
1.1.2.15.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteS3Bucket > SecretKey
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** S3 account secret access key
1.1.2.15.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DeleteS3Bucket > ForcePathStyle
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `true` | **Description:** When true, requests will always use path style addressing | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.16. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions` **Title:** DownloadRabbitMqDefinitions | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.16.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > ManagementScheme
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"http"` | **Description:** Rabbitmq management API scheme
1.1.2.16.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > ManagementPort
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `15672` | **Description:** Rabbitmq management API port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.16.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > AllowInvalidServerCertificates
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Allow invalid TLS certificates when using HTTPS | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.16.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30000` | **Description:** Rabbitmq management API request timeout in milliseconds | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.16.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.16.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.16.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.16.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.16.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.16.10. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > DefinitionsFilePath
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Output path for the downloaded rabbitmq definitions JSON
1.1.2.16.11. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DownloadRabbitMqDefinitions > VirtualHostName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional virtual host name for vhost-scoped definitions export
##### 1.1.2.17. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DropMongoDbCollection` **Title:** DropMongoDbCollection | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.17.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DropMongoDbCollection > ConnectionString
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Connection string to the MongoDB server
1.1.2.17.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DropMongoDbCollection > DatabaseName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Name of the database to perform the operation on
1.1.2.17.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DropMongoDbCollection > CollectionName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Name of the collection in the database to perform the operation on
1.1.2.17.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > DropMongoDbCollection > ChunkSize
| | | | ------------ | ------------------------- | | **Type** | `integer, null or string` | | **Required** | No | | **Format** | `int32` | **Description:** Chunk size of the data to process, This represents the number of documents to process in a single operation. If not specified, all data will be processed in a single chunk. | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
##### 1.1.2.18. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyElasticIndices` **Title:** EmptyElasticIndices | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.18.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyElasticIndices > MatchQueryString
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"*"` | **Description:** The match query string for the documents from the relevant indices
1.1.2.18.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyElasticIndices > IndexPattern
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The index pattern of the relevant indices
1.1.2.18.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyElasticIndices > Url
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | | **Format** | `uri` | **Description:** The url of the elasticsearch
1.1.2.18.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyElasticIndices > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The username of the elasticsearch
1.1.2.18.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyElasticIndices > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The password of the elasticsearch
1.1.2.18.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyElasticIndices > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Default** | `30000` | **Description:** The timeout in milliseconds on the requests sent to the elastic | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
##### 1.1.2.19. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyMongoDbCollection` **Title:** EmptyMongoDbCollection | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.19.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyMongoDbCollection > ConnectionString
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Connection string to the MongoDB server
1.1.2.19.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyMongoDbCollection > DatabaseName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Name of the database to perform the operation on
1.1.2.19.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyMongoDbCollection > CollectionName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Name of the collection in the database to perform the operation on
1.1.2.19.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyMongoDbCollection > ChunkSize
| | | | ------------ | ------------------------- | | **Type** | `integer, null or string` | | **Required** | No | | **Format** | `int32` | **Description:** Chunk size of the data to process, This represents the number of documents to process in a single operation. If not specified, all data will be processed in a single chunk. | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
##### 1.1.2.20. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks` **Title:** EmptyRedisByChunks | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.20.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > RedisDataBase
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `0` | **Description:** Redis database to perform the probe on | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.20.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > HostNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** List of the redis hostnames (each hostname should contain the port too for example: - 'host1:8080' | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------ | ----------- | | [HostNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i19_HostNames_items_i0) | - | ###### 1.1.2.20.2.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > HostNames > HostNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.20.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > Username
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** User for the redis server
1.1.2.20.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > Password
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Password for the redis server
1.1.2.20.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > AbortOnConnectFail
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `true` | **Description:** If true, connect will not create connection while no servers are available | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.20.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > ConnectRetry
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `3` | **Description:** The number of times to repeat connect attempts during initial connect | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.20.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > ClientName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Identification for the connection within redis
1.1.2.20.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > AsyncTimeout
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5000` | **Description:** Time(ms) to allow for asynchronous operations | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.20.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > Ssl
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Specifies that SSL encryption should be used | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.20.10. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > SslHost
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Enforces a preticular SSL host identity on the server's certificate
1.1.2.20.11. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > KeepAlive
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `60` | **Description:** Time (seconds) at which to send a message to help keep alive | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.20.12. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > BatchSize
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `100` | **Description:** Batch Size to do the operation on | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.20.13. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyRedisByChunks > KeyRegexPattern
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional regex used to filter which redis keys should be deleted
##### 1.1.2.21. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyS3Bucket` **Title:** EmptyS3Bucket | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.21.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyS3Bucket > StorageBucket
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Name of S3 bucket
1.1.2.21.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyS3Bucket > ServiceURL
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | | **Format** | `uri` | **Description:** S3 service url
1.1.2.21.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyS3Bucket > AccessKey
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** S3 account access key
1.1.2.21.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyS3Bucket > SecretKey
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** S3 account secret access key
1.1.2.21.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyS3Bucket > ForcePathStyle
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `true` | **Description:** When true, requests will always use path style addressing | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.21.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > EmptyS3Bucket > Prefix
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `""` | **Description:** Prefix of all objects to delete from s3 bucket
##### 1.1.2.22. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand` **Title:** ExecuteRedisCommand | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.22.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > RedisDataBase
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `0` | **Description:** Redis database to perform the probe on | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.22.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > HostNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** List of the redis hostnames (each hostname should contain the port too for example: - 'host1:8080' | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------ | ----------- | | [HostNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i21_HostNames_items_i0) | - | ###### 1.1.2.22.2.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > HostNames > HostNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.22.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > Username
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** User for the redis server
1.1.2.22.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > Password
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Password for the redis server
1.1.2.22.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > AbortOnConnectFail
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `true` | **Description:** If true, connect will not create connection while no servers are available | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.22.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > ConnectRetry
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `3` | **Description:** The number of times to repeat connect attempts during initial connect | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.22.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > ClientName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Identification for the connection within redis
1.1.2.22.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > AsyncTimeout
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5000` | **Description:** Time(ms) to allow for asynchronous operations | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.22.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > Ssl
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Specifies that SSL encryption should be used | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.22.10. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > SslHost
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Enforces a preticular SSL host identity on the server's certificate
1.1.2.22.11. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > KeepAlive
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `60` | **Description:** Time (seconds) at which to send a message to help keep alive | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.22.12. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > Command
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The redis command to execute
1.1.2.22.13. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > Arguments
| | | | ------------ | ----------------------- | | **Type** | `array, null or string` | | **Required** | No | **Description:** Optional redis command arguments | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------ | ----------- | | [Arguments item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i21_Arguments_items_i0) | - | ###### 1.1.2.22.13.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > Arguments > Arguments item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.22.14. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommand > StoreResultAs
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional alias used to store the command result for later redisResults placeholders
##### 1.1.2.23. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands` **Title:** ExecuteRedisCommands | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.23.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > RedisDataBase
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `0` | **Description:** Redis database to perform the probe on | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.23.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > HostNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** List of the redis hostnames (each hostname should contain the port too for example: - 'host1:8080' | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------ | ----------- | | [HostNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i22_HostNames_items_i0) | - | ###### 1.1.2.23.2.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > HostNames > HostNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.23.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > Username
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** User for the redis server
1.1.2.23.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > Password
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Password for the redis server
1.1.2.23.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > AbortOnConnectFail
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `true` | **Description:** If true, connect will not create connection while no servers are available | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.23.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > ConnectRetry
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `3` | **Description:** The number of times to repeat connect attempts during initial connect | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.23.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > ClientName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Identification for the connection within redis
1.1.2.23.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > AsyncTimeout
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5000` | **Description:** Time(ms) to allow for asynchronous operations | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.23.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > Ssl
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Specifies that SSL encryption should be used | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.23.10. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > SslHost
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Enforces a preticular SSL host identity on the server's certificate
1.1.2.23.11. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > KeepAlive
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `60` | **Description:** Time (seconds) at which to send a message to help keep alive | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.23.12. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > Commands
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The redis commands to execute | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ---------------------------------------------------------------------------------- | ----------- | | [Commands item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i22_Commands_items_i0) | - | ###### 1.1.2.23.12.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > Commands > Commands item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.23.12.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > Commands > Commands item 0 > Command
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The redis command to execute
1.1.2.23.12.1.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > Commands > Commands item 0 > Arguments
| | | | ------------ | ----------------------- | | **Type** | `array, null or string` | | **Required** | No | **Description:** Optional redis command arguments | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------------------------ | ----------- | | [Arguments item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i22_Commands_items_i0_Arguments_items_i0) | - | ###### 1.1.2.23.12.1.2.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > Commands > Commands item 0 > Arguments > Arguments item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.23.12.1.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > Commands > Commands item 0 > StoreResultAs
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional alias used to store the command result for later redisResults placeholders
1.1.2.23.13. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > RepeatUntil
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** Optional loop that repeats the command sequence until a stored redis result path matches the expected value | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.23.13.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > RepeatUntil > ResultPath
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Stored redisResults path to inspect after each command sequence iteration
1.1.2.23.13.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > RepeatUntil > ExpectedValue
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Scalar value that ends the loop when the resolved ResultPath matches it
1.1.2.23.13.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > ExecuteRedisCommands > RepeatUntil > MaxIterations
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `100` | **Description:** Safety cap for loop iterations | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
##### 1.1.2.24. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis` **Title:** FlushAllRedis | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.24.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > HostNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** List of the redis hostnames (each hostname should contain the port too for example: - 'host1:8080' | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------ | ----------- | | [HostNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i23_HostNames_items_i0) | - | ###### 1.1.2.24.1.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > HostNames > HostNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.24.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > Username
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** User for the redis server
1.1.2.24.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > Password
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Password for the redis server
1.1.2.24.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > AbortOnConnectFail
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `true` | **Description:** If true, connect will not create connection while no servers are available | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.24.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > ConnectRetry
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `3` | **Description:** The number of times to repeat connect attempts during initial connect | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.24.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > ClientName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Identification for the connection within redis
1.1.2.24.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > AsyncTimeout
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5000` | **Description:** Time(ms) to allow for asynchronous operations | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.24.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > Ssl
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Specifies that SSL encryption should be used | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.24.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > SslHost
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Enforces a preticular SSL host identity on the server's certificate
1.1.2.24.10. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushAllRedis > KeepAlive
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `60` | **Description:** Time (seconds) at which to send a message to help keep alive | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.25. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis` **Title:** FlushDbRedis | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.25.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > HostNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** List of the redis hostnames (each hostname should contain the port too for example: - 'host1:8080' | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------ | ----------- | | [HostNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i24_HostNames_items_i0) | - | ###### 1.1.2.25.1.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > HostNames > HostNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.25.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > Username
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** User for the redis server
1.1.2.25.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > Password
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Password for the redis server
1.1.2.25.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > AbortOnConnectFail
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `true` | **Description:** If true, connect will not create connection while no servers are available | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.25.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > ConnectRetry
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `3` | **Description:** The number of times to repeat connect attempts during initial connect | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.25.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > ClientName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Identification for the connection within redis
1.1.2.25.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > AsyncTimeout
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5000` | **Description:** Time(ms) to allow for asynchronous operations | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.25.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > Ssl
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Specifies that SSL encryption should be used | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.25.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > SslHost
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Enforces a preticular SSL host identity on the server's certificate
1.1.2.25.10. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > KeepAlive
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `60` | **Description:** Time (seconds) at which to send a message to help keep alive | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.25.11. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > FlushDbRedis > RedisDataBase
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `0` | **Description:** Redis database to perform the probe on | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.26. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > MsSqlDataBaseTablesTruncate` **Title:** MsSqlDataBaseTablesTruncate | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.26.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > MsSqlDataBaseTablesTruncate > ConnectionString
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The connection string to the database
1.1.2.26.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > MsSqlDataBaseTablesTruncate > TableNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The names of all the tables to truncate, they will be truncated by the order they are given in this list | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | -------------------------------------------------------------------------------------- | ----------- | | [TableNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i25_TableNames_items_i0) | - | ###### 1.1.2.26.2.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > MsSqlDataBaseTablesTruncate > TableNames > TableNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.26.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > MsSqlDataBaseTablesTruncate > CommandTimeoutSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30` | **Description:** The wait time (in seconds) before terminating the attempt to execute the truncate command and generating an error | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
##### 1.1.2.27. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OracleSqlDataBaseTablesTruncate` **Title:** OracleSqlDataBaseTablesTruncate | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.27.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OracleSqlDataBaseTablesTruncate > ConnectionString
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The connection string to the database
1.1.2.27.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OracleSqlDataBaseTablesTruncate > TableNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The names of all the tables to truncate, they will be truncated by the order they are given in this list | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | -------------------------------------------------------------------------------------- | ----------- | | [TableNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i26_TableNames_items_i0) | - | ###### 1.1.2.27.2.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OracleSqlDataBaseTablesTruncate > TableNames > TableNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.27.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OracleSqlDataBaseTablesTruncate > CommandTimeoutSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30` | **Description:** The wait time (in seconds) before terminating the attempt to execute the truncate command and generating an error | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
##### 1.1.2.28. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars` **Title:** OsChangeDeploymentEnvVars | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.28.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > ReplicaSetName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the replicaset to scale the pods of
1.1.2.28.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > IntervalBetweenDesiredStateChecksMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `1000` | **Description:** The interval in milliseconds between every check of the replica set's state (if it reached the desired number of pods yet) | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.28.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > TimeoutWaitForDesiredStateSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `300` | **Description:** The timeout in seconds for waiting for the replicaset to scale to the given number of pods, when timeout is reached an error log is raised and the code continues to run | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.28.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.28.4.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.28.4.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.28.4.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.28.4.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.28.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > ContainerName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The name of the container we would like to update, if not given - the probe will update all of the pod's containers
1.1.2.28.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > EnvVarsToUpdate
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** The environment variables to update/add | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.28.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > EnvVarsToRemove
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | No | **Description:** The environment variables to remove | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------------------ | ----------- | | [EnvVarsToRemove item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i27_EnvVarsToRemove_items_i0) | - | ###### 1.1.2.28.7.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeDeploymentEnvVars > EnvVarsToRemove > EnvVarsToRemove item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
##### 1.1.2.29. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars` **Title:** OsChangeStatefulSetEnvVars | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.29.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > ReplicaSetName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the replicaset to scale the pods of
1.1.2.29.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > IntervalBetweenDesiredStateChecksMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `1000` | **Description:** The interval in milliseconds between every check of the replica set's state (if it reached the desired number of pods yet) | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.29.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > TimeoutWaitForDesiredStateSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `300` | **Description:** The timeout in seconds for waiting for the replicaset to scale to the given number of pods, when timeout is reached an error log is raised and the code continues to run | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.29.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.29.4.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.29.4.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.29.4.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.29.4.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.29.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > ContainerName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The name of the container we would like to update, if not given - the probe will update all of the pod's containers
1.1.2.29.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > EnvVarsToUpdate
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** The environment variables to update/add | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.29.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > EnvVarsToRemove
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | No | **Description:** The environment variables to remove | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------------------------------------------------------------------------ | ----------- | | [EnvVarsToRemove item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i28_EnvVarsToRemove_items_i0) | - | ###### 1.1.2.29.7.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsChangeStatefulSetEnvVars > EnvVarsToRemove > EnvVarsToRemove item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
##### 1.1.2.30. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsEditYamlConfigMap` **Title:** OsEditYamlConfigMap | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.30.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsEditYamlConfigMap > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.30.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsEditYamlConfigMap > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.30.1.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsEditYamlConfigMap > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.30.1.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsEditYamlConfigMap > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.30.1.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsEditYamlConfigMap > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.30.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsEditYamlConfigMap > ConfigMapName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The config map to edit
1.1.2.30.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsEditYamlConfigMap > ConfigMapYamlFileName
| | | | ------------ | ----------------- | | **Type** | `string` | | **Required** | No | | **Default** | `"ConfigMap.yml"` | **Description:** The name of the yaml file inside the config map data
1.1.2.30.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsEditYamlConfigMap > ValuesToEdit
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** The description of the configmap paths and values to change (in JSONPath format). For example:path.to.yaml.value[0]: new value | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.31. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers` **Title:** OsExecuteCommandsInContainers | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.31.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.31.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.31.1.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.31.1.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.31.1.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.31.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > ApplicationLabels
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** A list of the k8s labels of the pods to execute the command in, for example: app=test | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ---------------------------------------------------------------------------------------------------- | ----------- | | [ApplicationLabels item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i30_ApplicationLabels_items_i0) | - | ###### 1.1.2.31.2.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > ApplicationLabels > ApplicationLabels item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.31.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > Commands
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** A list of the commands to execute in the chosen containers | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ---------------------------------------------------------------------------------- | ----------- | | [Commands item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i30_Commands_items_i0) | - | ###### 1.1.2.31.3.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > Commands > Commands item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.31.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsExecuteCommandsInContainers > ContainerName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The name of the container to run the commands in in all the found pods, if no name is given runs the command in all pod containers
##### 1.1.2.32. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods` **Title:** OsRestartPods | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.32.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.32.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.32.1.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.32.1.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.32.1.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.32.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods > ApplicationLabels
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** A list of the k8s labels of the pods to execute the command in, for example: app=test | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ---------------------------------------------------------------------------------------------------- | ----------- | | [ApplicationLabels item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i31_ApplicationLabels_items_i0) | - | ###### 1.1.2.32.2.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods > ApplicationLabels > ApplicationLabels item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.32.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods > IntervalBetweenDesiredStateChecksMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `1000` | **Description:** The interval in milliseconds between every check of the pod's state (if they are ready yet) | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.32.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsRestartPods > TimeoutWaitForDesiredStateSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `300` | **Description:** The timeout in seconds for waiting for the pods to stop restarting, when timeout is reached an error log is raised and the code continues to run | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
##### 1.1.2.33. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods` **Title:** OsScaleDeploymentPods | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.33.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods > ReplicaSetName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the replicaset to scale the pods of
1.1.2.33.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods > IntervalBetweenDesiredStateChecksMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `1000` | **Description:** The interval in milliseconds between every check of the replica set's state (if it reached the desired number of pods yet) | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.33.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods > TimeoutWaitForDesiredStateSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `300` | **Description:** The timeout in seconds for waiting for the replicaset to scale to the given number of pods, when timeout is reached an error log is raised and the code continues to run | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.33.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.33.4.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.33.4.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.33.4.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.33.4.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.33.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleDeploymentPods > DesiredNumberOfPods
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | Yes | | **Format** | `int32` | **Description:** The number of pods to scale the replica set to | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.34. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods` **Title:** OsScaleStatefulSetPods | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.34.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods > ReplicaSetName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the replicaset to scale the pods of
1.1.2.34.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods > IntervalBetweenDesiredStateChecksMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `1000` | **Description:** The interval in milliseconds between every check of the replica set's state (if it reached the desired number of pods yet) | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.34.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods > TimeoutWaitForDesiredStateSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `300` | **Description:** The timeout in seconds for waiting for the replicaset to scale to the given number of pods, when timeout is reached an error log is raised and the code continues to run | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.34.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.34.4.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.34.4.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.34.4.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.34.4.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.34.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsScaleStatefulSetPods > DesiredNumberOfPods
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | Yes | | **Format** | `int32` | **Description:** The number of pods to scale the replica set to | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
##### 1.1.2.35. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage` **Title:** OsUpdateDeploymentImage | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.35.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > ContainerName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the container to update
1.1.2.35.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > ReplicaSetName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the replicaset to scale the pods of
1.1.2.35.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > IntervalBetweenDesiredStateChecksMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `1000` | **Description:** The interval in milliseconds between every check of the replica set's state (if it reached the desired number of pods yet) | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.35.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > TimeoutWaitForDesiredStateSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `300` | **Description:** The timeout in seconds for waiting for the replicaset to scale to the given number of pods, when timeout is reached an error log is raised and the code continues to run | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.35.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.35.5.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.35.5.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.35.5.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.35.5.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.35.6. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentImage > DesiredImage
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The desired image to update the container to
##### 1.1.2.36. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources` **Title:** OsUpdateDeploymentResources | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.36.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > ContainerName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the container to update
1.1.2.36.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > ReplicaSetName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the replicaset to scale the pods of
1.1.2.36.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > IntervalBetweenDesiredStateChecksMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `1000` | **Description:** The interval in milliseconds between every check of the replica set's state (if it reached the desired number of pods yet) | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.36.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > TimeoutWaitForDesiredStateSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `300` | **Description:** The timeout in seconds for waiting for the replicaset to scale to the given number of pods, when timeout is reached an error log is raised and the code continues to run | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.36.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.36.5.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.36.5.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.36.5.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.36.5.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.36.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > DesiredResources
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** The resources to update the replicaset with. Overrides the current replicaset's resources. | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.36.6.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > DesiredResources > Requests
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** The requests resources to update the replicaset with | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.36.6.1.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > DesiredResources > Requests > Cpu
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The amount of cpu to update the replicaset with
1.1.2.36.6.1.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > DesiredResources > Requests > Memory
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The amount of memory to update the replicaset with
1.1.2.36.6.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > DesiredResources > Limits
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** The limits resources to update the replicaset with | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.36.6.2.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > DesiredResources > Limits > Cpu
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The amount of cpu to update the replicaset with
1.1.2.36.6.2.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateDeploymentResources > DesiredResources > Limits > Memory
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The amount of memory to update the replicaset with
##### 1.1.2.37. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage` **Title:** OsUpdateStatefulSetImage | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.37.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > ContainerName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the container to update
1.1.2.37.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > ReplicaSetName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the replicaset to scale the pods of
1.1.2.37.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > IntervalBetweenDesiredStateChecksMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `1000` | **Description:** The interval in milliseconds between every check of the replica set's state (if it reached the desired number of pods yet) | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.37.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > TimeoutWaitForDesiredStateSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `300` | **Description:** The timeout in seconds for waiting for the replicaset to scale to the given number of pods, when timeout is reached an error log is raised and the code continues to run | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.37.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.37.5.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.37.5.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.37.5.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.37.5.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.37.6. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetImage > DesiredImage
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The desired image to update the container to
##### 1.1.2.38. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources` **Title:** OsUpdateStatefulSetResources | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.38.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > ContainerName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the container to update
1.1.2.38.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > ReplicaSetName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The name of the replicaset to scale the pods of
1.1.2.38.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > IntervalBetweenDesiredStateChecksMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `1000` | **Description:** The interval in milliseconds between every check of the replica set's state (if it reached the desired number of pods yet) | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.38.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > TimeoutWaitForDesiredStateSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `300` | **Description:** The timeout in seconds for waiting for the replicaset to scale to the given number of pods, when timeout is reached an error log is raised and the code continues to run | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.38.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > Openshift
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | Yes | **Description:** The openshift environment to perform action in | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.38.5.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > Openshift > Cluster
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift cluster api
1.1.2.38.5.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > Openshift > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Username with access to the openshift namespace and application
1.1.2.38.5.3. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > Openshift > Password
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Password of the username with access to the openshift namespace and application
1.1.2.38.5.4. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > Openshift > Namespace
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The openshift namespace the application is at
1.1.2.38.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > DesiredResources
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** The resources to update the replicaset with. Overrides the current replicaset's resources. | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.38.6.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > DesiredResources > Requests
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** The requests resources to update the replicaset with | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.38.6.1.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > DesiredResources > Requests > Cpu
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The amount of cpu to update the replicaset with
1.1.2.38.6.1.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > DesiredResources > Requests > Memory
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The amount of memory to update the replicaset with
1.1.2.38.6.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > DesiredResources > Limits
| | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | **Description:** The limits resources to update the replicaset with | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.38.6.2.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > DesiredResources > Limits > Cpu
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The amount of cpu to update the replicaset with
1.1.2.38.6.2.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > OsUpdateStatefulSetResources > DesiredResources > Limits > Memory
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** The amount of memory to update the replicaset with
##### 1.1.2.39. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PostgreSqlDataBaseTablesTruncate` **Title:** PostgreSqlDataBaseTablesTruncate | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.39.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PostgreSqlDataBaseTablesTruncate > ConnectionString
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The connection string to the database
1.1.2.39.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PostgreSqlDataBaseTablesTruncate > TableNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The names of all the tables to truncate, they will be truncated by the order they are given in this list | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | -------------------------------------------------------------------------------------- | ----------- | | [TableNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i38_TableNames_items_i0) | - | ###### 1.1.2.39.2.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PostgreSqlDataBaseTablesTruncate > TableNames > TableNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
1.1.2.39.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PostgreSqlDataBaseTablesTruncate > CommandTimeoutSeconds
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30` | **Description:** The wait time (in seconds) before terminating the attempt to execute the truncate command and generating an error | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
##### 1.1.2.40. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PurgeRabbitMqQueues` **Title:** PurgeRabbitMqQueues | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.40.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PurgeRabbitMqQueues > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.40.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PurgeRabbitMqQueues > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.40.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PurgeRabbitMqQueues > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.40.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PurgeRabbitMqQueues > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.40.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PurgeRabbitMqQueues > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.40.6. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PurgeRabbitMqQueues > QueueNames
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** A list of the names of all the queues to purge from the given rabbitmq | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | -------------------------------------------------------------------------------------- | ----------- | | [QueueNames item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i39_QueueNames_items_i0) | - | ###### 1.1.2.40.6.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > PurgeRabbitMqQueues > QueueNames > QueueNames item 0 | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No |
##### 1.1.2.41. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions` **Title:** UploadRabbitMqDefinitions | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.41.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > ManagementScheme
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"http"` | **Description:** Rabbitmq management API scheme
1.1.2.41.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > ManagementPort
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `15672` | **Description:** Rabbitmq management API port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.41.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > AllowInvalidServerCertificates
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Allow invalid TLS certificates when using HTTPS | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.41.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30000` | **Description:** Rabbitmq management API request timeout in milliseconds | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.41.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.41.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.41.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.41.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.41.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.41.10. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > DefinitionsJson
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional inline JSON payload with rabbitmq definitions
1.1.2.41.11. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > DefinitionsFilePath
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional path to a JSON file containing rabbitmq definitions
1.1.2.41.12. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UploadRabbitMqDefinitions > VirtualHostName
| | | | ------------ | ---------------- | | **Type** | `null or string` | | **Required** | No | **Description:** Optional virtual host name for vhost-scoped definitions import
##### 1.1.2.42. Property `probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions` **Title:** UpsertRabbitMqPermissions | | | | ------------ | ------------------------ | | **Type** | `null, object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.42.1. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > ManagementScheme
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"http"` | **Description:** Rabbitmq management API scheme
1.1.2.42.2. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > ManagementPort
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `15672` | **Description:** Rabbitmq management API port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.42.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > AllowInvalidServerCertificates
| | | | ------------ | ------------------- | | **Type** | `boolean or string` | | **Required** | No | | **Default** | `false` | **Description:** Allow invalid TLS certificates when using HTTPS | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.42.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > RequestTimeoutMs
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `30000` | **Description:** Rabbitmq management API request timeout in milliseconds | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.42.5. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Host
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** Rabbitmq hostname
1.1.2.42.6. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Username
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq username
1.1.2.42.7. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Password
| | | | ------------ | --------- | | **Type** | `string` | | **Required** | No | | **Default** | `"admin"` | **Description:** Rabbitmq password
1.1.2.42.8. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Port
| | | | ------------ | ------------------- | | **Type** | `integer or string` | | **Required** | No | | **Format** | `int32` | | **Default** | `5672` | **Description:** Rabbitmq Amqp port | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | **Minimum** | N/A | | **Maximum** | N/A |
1.1.2.42.9. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > VirtualHost
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `"/"` | **Description:** Rabbitmq virtual host to access during this connection
1.1.2.42.10. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Permissions
| | | | ------------ | ----------------- | | **Type** | `array or string` | | **Required** | Yes | **Description:** The rabbitmq permissions to create or update | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | False | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ---------------------------------------------------------------------------------------- | ----------- | | [Permissions item 0](#Probes_items_i0_ProbeConfiguration_anyOf_i41_Permissions_items_i0) | - | ###### 1.1.2.42.10.1. probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Permissions > Permissions item 0 | | | | ------------ | ------------------ | | **Type** | `object or string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |
1.1.2.42.10.1.1. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Permissions > Permissions item 0 > VirtualHostName
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The rabbitmq virtual host name
1.1.2.42.10.1.2. [Required] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Permissions > Permissions item 0 > Username
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | **Description:** The rabbitmq user name
1.1.2.42.10.1.3. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Permissions > Permissions item 0 > Configure
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `".*"` | **Description:** Regex for configure permissions
1.1.2.42.10.1.4. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Permissions > Permissions item 0 > Write
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `".*"` | **Description:** Regex for write permissions
1.1.2.42.10.1.5. [Optional] Property probes 0.0.0 > Probes > Probes item 0 > ProbeConfiguration > anyOf > UpsertRabbitMqPermissions > Permissions > Permissions item 0 > Read
| | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | **Default** | `".*"` | **Description:** Regex for read permissions
| Restrictions | | | --------------------------------- | ------------------------------------------------------------------------- | | **Must match regular expression** | ```\$\{.*\}``` [Test](https://regex101.com/?regex=%5C%24%5C%7B.%2A%5C%7D) |

Generated using json-schema-for-humans on 2026-05-22 at 15:20:32 +0300