NomadClient.Api.System (nomad_client v0.13.1)
API calls for all endpoints tagged System
.
Link to this section Summary
Functions
Parameters
connection
(NomadClient.Connection): Connection to serveropts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
Parameters
connection
(NomadClient.Connection): Connection to serveropts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
Link to this section Functions
Link to this function
put_system_gc(connection, opts \\ [])
@spec put_system_gc( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
parameters
Parameters
connection
(NomadClient.Connection): Connection to serveropts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
Link to this function
put_system_reconcile_summaries(connection, opts \\ [])
@spec put_system_reconcile_summaries( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
parameters
Parameters
connection
(NomadClient.Connection): Connection to serveropts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure