Skip to navigation

Switch TLS and Certificates

View as MarkdownOpen in Claude

Install switch mTLS certificates and disable switch mTLS.

RPCExecutionSummary
ConfigureSwitchCertificateAsynchronous, parent and child jobsConfigureSwitchCertificate initiates asynchronous RMS-configured TLS certificate installation on all supplied switches.
BatchDisableSwitchMtlsAsynchronous, parent and child jobsBatchDisableSwitchMtls asynchronously disables mTLS for selected services on caller-supplied switches.

For definitions of execution modes and job polling, refer to Async jobs.

ConfigureSwitchCertificate

rack_manager.RackManager/ConfigureSwitchCertificate

ConfigureSwitchCertificate initiates asynchronous RMS-configured TLS certificate installation on all supplied switches. Returns a parent job ID for tracking overall progress, along with individual child job IDs per switch.

PropertyValue
ExecutionAsynchronous, parent and child jobs. The response returns a parent job ID and the work continues after the call returns.
Job trackingPoll GetConfigureSwitchCertificateJobStatus with the job ID in response.job_id. Per-node child job IDs are in jobs.
TargetCaller-supplied nodes. The request carries each node’s endpoints and credentials, and RMS does not store them.
Behavior detailsOperations guide
Protobuf referenceConfigureSwitchCertificate

Request: ConfigureSwitchCertificateRequest

FieldTypeDescription
nodesNodeSetSwitch nodes to update
servicesrepeated SwitchServiceSwitch services to protect with the installed mTLS certificates
test_helloboolTest Hello Connection over mTLS
domainoptional stringOptional site selector; defaults to —default-switch-domain when unset.

Response: ConfigureSwitchCertificateResponse

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is parent job id
jobsrepeated ConfigureSwitchCertificateJobInfoIndividual child job ID per switch

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"nodes": {
"nodes": [
{
"node_id": "<node_id>",
"rack_id": "<rack_id>",
"type": "COMPUTE_GB200_NVIDIA",
"bmc_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"host_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"additional_host_endpoints": [
{
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
}
]
}
]
},
"services": [
"SWITCH_SERVICE_NVUE_API"
],
"test_hello": false,
"domain": "<domain>"
}' \
"$RMS_ADDR" rack_manager.RackManager/ConfigureSwitchCertificate

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> switch configure_certificate <switches.csv> --service <service>

BatchDisableSwitchMtls

rack_manager.RackManager/BatchDisableSwitchMtls

BatchDisableSwitchMtls asynchronously disables mTLS for selected services on caller-supplied switches. Returns a parent job ID for GetJobStatus.

PropertyValue
ExecutionAsynchronous, parent and child jobs. The response returns a parent job ID and the work continues after the call returns.
Job trackingPoll GetJobStatus with the job ID in response.job_id. Set include_child_job_states on GetJobStatus to read per-node child jobs.
TargetCaller-supplied nodes. The request carries each node’s endpoints and credentials, and RMS does not store them.
Behavior detailsOperations guide
Protobuf referenceBatchDisableSwitchMtls

Request: BatchDisableSwitchMtlsRequest

FieldTypeDescription
nodesNodeSetTarget switch identities and direct connection information
servicesrepeated SwitchServiceSwitch services that should stop requiring mTLS

Response: BatchDisableSwitchMtlsResponse

FieldTypeDescription
responseNodeBatchResponseresponse.job_id is the parent job ID for GetJobStatus

Errors: Refer to Conventions for how RMS reports failures.

Replace each <placeholder> with a real value. Define RMS_GRPCURL_FLAGS and RMS_ADDR as described in Getting started.

grpcurl $RMS_GRPCURL_FLAGS \
-d '{
"nodes": {
"nodes": [
{
"node_id": "<node_id>",
"rack_id": "<rack_id>",
"type": "COMPUTE_GB200_NVIDIA",
"bmc_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"host_endpoint": {
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
},
"node_descriptor": {
"attributes": {
"<key>": "<attributes>"
}
},
"additional_host_endpoints": [
{
"interface": {
"ip_address": "<ip_address>",
"mac_address": "<mac_address>",
"host_name": "<host_name>"
},
"port": 0,
"credentials": {
"user_pass": {
"username": "<username>",
"password": "<password>"
}
}
}
]
}
]
},
"services": [
"SWITCH_SERVICE_NVUE_API"
]
}' \
"$RMS_ADDR" rack_manager.RackManager/BatchDisableSwitchMtls

The rack_manager_client test client offers an equivalent command:

rack_manager_client <host> <port> switch disable_mtls <switches.csv> --service <service>