Package | Description |
---|---|
com.suse.salt.netapi.calls | |
com.suse.salt.netapi.client | |
com.suse.salt.netapi.client.impl | |
com.suse.salt.netapi.event | |
com.suse.salt.netapi.exception |
Modifier and Type | Method and Description |
---|---|
WheelAsyncResult<R> |
WheelCall.callAsync(SaltClient client)
Calls a wheel module function on the master asynchronously and
returns information about the scheduled job that can be used to query the result.
|
RunnerAsyncResult<R> |
RunnerCall.callAsync(SaltClient client)
Calls a runner module function on the master asynchronously and
returns information about the scheduled job that can be used to query the result.
|
WheelAsyncResult<R> |
WheelCall.callAsync(SaltClient client,
String username,
String password,
AuthModule authModule)
Calls a wheel module function on the master asynchronously and
returns information about the scheduled job that can be used to query the result.
|
RunnerAsyncResult<R> |
RunnerCall.callAsync(SaltClient client,
String username,
String password,
AuthModule authModule)
Calls a runner module function on the master asynchronously and
returns information about the scheduled job that can be used to query the result.
|
LocalAsyncResult<R> |
LocalCall.callAsync(SaltClient client,
Target<?> target)
Calls a execution module function on the given target asynchronously and
returns information about the scheduled job that can be used to query the result.
|
LocalAsyncResult<R> |
LocalCall.callAsync(SaltClient client,
Target<?> target,
String username,
String password,
AuthModule authModule)
Calls a execution module function on the given target asynchronously and
returns information about the scheduled job that can be used to query the result.
|
WheelResult<R> |
WheelCall.callSync(SaltClient client)
Calls a wheel module function on the master and synchronously
waits for the result.
|
R |
RunnerCall.callSync(SaltClient client)
Calls a runner module function on the master and synchronously
waits for the result.
|
WheelResult<R> |
WheelCall.callSync(SaltClient client,
String username,
String password,
AuthModule authModule)
Calls a wheel module function on the master and synchronously
waits for the result.
|
R |
RunnerCall.callSync(SaltClient client,
String username,
String password,
AuthModule authModule)
Calls a runner module function on the master and synchronously
waits for the result.
|
Map<String,Result<R>> |
LocalCall.callSync(SaltClient client,
Target<?> target)
Calls a execution module function on the given target and synchronously
waits for the result.
|
List<Map<String,Result<R>>> |
LocalCall.callSync(SaltClient client,
Target<?> target,
Batch batch)
Calls a execution module function on the given target with batching and
synchronously waits for the result.
|
Map<String,Result<R>> |
LocalCall.callSync(SaltClient client,
Target<?> target,
String username,
String password,
AuthModule authModule)
Calls a execution module function on the given target and synchronously
waits for the result.
|
List<Map<String,Result<R>>> |
LocalCall.callSync(SaltClient client,
Target<?> target,
String username,
String password,
AuthModule authModule,
Batch batch)
Calls a execution module function on the given target with batching and
synchronously waits for the result.
|
Map<String,Result<SSHResult<R>>> |
LocalCall.callSyncSSH(SaltClient client,
Target<?> target,
SaltSSHConfig cfg)
Call an execution module function on the given target via salt-ssh and synchronously
wait for the result.
|
Modifier and Type | Method and Description |
---|---|
<R> R |
SaltClient.call(Call<?> call,
Client client,
String endpoint,
Optional<Map<String,Object>> custom,
com.google.gson.reflect.TypeToken<R> type)
|
<R> R |
SaltClient.call(Call<?> call,
Client client,
String endpoint,
com.google.gson.reflect.TypeToken<R> type)
Convenience method to make a call without arguments.
|
EventStream |
SaltClient.events(EventListener... listeners)
Returns a WebSocket @ClientEndpoint annotated object connected
to the /ws ServerEndpoint.
|
ResultInfoSet |
SaltClient.getJobResult(ScheduledJob job)
Query for the result of a supplied job.
|
ResultInfoSet |
SaltClient.getJobResult(String job)
Query for the result of a supplied job.
|
Map<String,Job> |
SaltClient.getJobs()
Get previously run jobs.
|
Map<String,Object> |
SaltClient.getMinionDetails(String minionId)
Query for details (grains) of the specified minion.
|
Future<Map<String,Object>> |
SaltClient.getMinionDetailsAsync(String minionId)
Query for details (grains) of the specified minion asynchronously.
|
Map<String,Map<String,Object>> |
SaltClient.getMinions()
Query for all minions and immediately return a map of minions keyed by minion id.
|
Future<Map<String,Map<String,Object>>> |
SaltClient.getMinionsAsync()
Asynchronously query for all minions and return a map of minions keyed by minion id.
|
T |
Connection.getResult()
Send a GET request and parse the result into object of given
Type . |
T |
Connection.getResult(String data)
Send a POST request and parse the result into object of given
Type . |
Key.Names |
SaltClient.keys()
Query general key information.
|
Token |
SaltClient.login(String username,
String password,
AuthModule eauth)
Perform login and return the token.
|
boolean |
SaltClient.logout()
Perform logout and clear the session token from the config.
|
<T> Map<String,Object> |
SaltClient.run(String username,
String password,
AuthModule eauth,
String client,
Target<T> target,
String function,
List<Object> args,
Map<String,Object> kwargs)
Generic interface to start any execution command bypassing normal session handling.
|
<T> Map<String,Result<SSHRawResult>> |
SaltClient.runRawSSHCommand(String command,
Target<T> target,
SaltSSHConfig cfg)
Calls salt-ssh with a command in raw shell mode (commands bypass Salt and
gets executed as shell commands).
|
boolean |
SaltClient.sendEvent(String eventTag,
String eventData)
Trigger an event in Salt with the specified tag and data.
|
<T> ScheduledJob |
SaltClient.startCommand(Target<T> target,
String function,
List<Object> args,
Map<String,Object> kwargs)
Generic interface to start any execution command and immediately return an object
representing the scheduled job.
|
Stats |
SaltClient.stats()
Query statistics from the CherryPy Server.
|
Modifier and Type | Method and Description |
---|---|
T |
JDKConnection.getResult()
Send a GET request and parse the result into object of given
Type . |
T |
HttpClientConnection.getResult()
Send a GET request and parse the result into object of given
Type . |
T |
JDKConnection.getResult(String data)
Send a POST request and parse the result into object of given
Type . |
T |
HttpClientConnection.getResult(String data)
Send a POST request and parse the result into object of given
Type . |
Constructor and Description |
---|
EventStream(ClientConfig config,
EventListener... listeners)
Constructor used to create an event stream: open a websocket connection and start
event processing.
|
Modifier and Type | Class and Description |
---|---|
class |
MessageTooBigException
Exception to be thrown in case of a websocket message exceeding the configurable
maximum message length.
|
class |
SaltUserUnauthorizedException
Exception for when a user is logged in but not allowed
access to the requested resource.
|
Copyright © 2016. All rights reserved.