Start Domain Maintenance

opensearchservice_start_domain_maintenance

R Documentation

Starts the node maintenance process on the data node¶

Description¶

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

Usage¶

opensearchservice_start_domain_maintenance(DomainName, Action, NodeId)

Arguments¶

DomainName

[required] The name of the domain.

Action

[required] The name of the action.

NodeId

The ID of the data node.

Value¶

A list with the following syntax:

list(
  MaintenanceId = "string"
)

Request syntax¶

svc$start_domain_maintenance(
  DomainName = "string",
  Action = "REBOOT_NODE"|"RESTART_SEARCH_PROCESS"|"RESTART_DASHBOARD",
  NodeId = "string"
)