SystemsApi: Agave Systems API operations
In deardooley/agave-rlang-sdk: Agave Platform client SDK for R
Description
Usage
Format
Details
Arguments
Methods
See Also
Description
SystemsApi Class
Usage
1
systems <- SystemsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )
Format
An object of class R6ClassGenerator of length 24.
Details
A system in Agave represents a server or collection of servers. A server can be physical, virtual, or a collection of servers exposed through a single hostname or ip address. Systems are identified and referenced in Agave by a unique ID unrelated to their ip address or hostname. Because of this, a single physical system may be registered multiple times. This allows different users to configure and use a system in whatever way they need to for their specific needs.
Systems come in two flavors: storage and execution. Storage systems are only used for storing and interacting with data. Execution systems are used for running apps (aka jobs or batch jobs) as well as storing and interacting with data.
The Systems service gives you the ability to add and discover storage and compute resources for use in the rest of the API. You may add as many or as few storage systems as you need to power your digital lab. When you register a system, it is private to you and you alone. Systems can also be published into the public space for all users to use. Depending on who is administering Agave for your organization, this may have already happened and you may already have one or more storage systems available to you by default.
Read more about the Systems API in the Agave Developer's Guide
Arguments
apiClient a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.
cache an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.
responseType the default object type methods of this class should return. Valid values are:
-
raw: the raw JSON string response from the API. You may optionally include
pretty=TRUE in the method call to receive pretty printed JSON.
-
list: a standard R list object. This is the default value.
-
dt: a data table
Methods
$addExecutionSystem() Add a new execution system
Usage
1
systems$addExecutionSystem$listSystems(body, naked, )
$addStorageSystem() Add a storage system
Usage
1
systems$addStorageSystem$listSystems(body, naked, )
$addSystemCredential() Add an internal user's credential on a system. This applies both to storage and, if applicable, login credentials.
Usage
1
systems$addSystemCredential$listSystems(systemId, body, naked, )
$addSystemRole() Adds a role on the system for the given user
Usage
1
systems$addSystemRole$listSystems(systemId, body, naked, )
$clearSystemAuthCredentials() Deletes all credentials registered to a system.
Usage
1
systems$clearSystemAuthCredentials$listSystems(systemId, naked, )
$clearSystemAuthCredentialsForInternalUser() Deletes all internal user credentials registered to a system.
Usage
1
systems$clearSystemAuthCredentialsForInternalUser$listSystems(systemId, internalUsername, naked, )
$clearSystemRoles() Deletes all roles on a system.
Usage
1
systems$clearSystemRoles$listSystems(systemId, naked, )
$deleteSystem() Delete a system.
Usage
1
systems$deleteSystem$listSystems(systemId, naked, )
$deleteSystemAuthCredentialForInternalUser() Deletes the internal user credentials for the given credential type on a system.
Usage
1
systems$deleteSystemAuthCredentialForInternalUser$listSystems(systemId, internalUsername, credentialType, naked, )
$deleteSystemRole() Deletes all roles for a user on a system.
Usage
1
systems$deleteSystemRole$listSystems(systemId, username, naked, )
$getSystemCredential() Get the internal user credential of the given type on the system.
Usage
1
2
$getSystemDetails() Find information about an individual system.
Usage
1
2
$getSystemRole() Get a specific user role on this system.
Usage
1
systems$getSystemRole$listSystems(systemId, username, naked, )
$invokeSystemAction() Perform a management action on the system.
Usage
1
systems$invokeSystemAction$listSystems(systemId, body, naked, )
$listCredentialsForInternalUser() Get a list of all internal users and their credentials on this system.
Usage
1
2
$listSystemCredentials() Get a list of all internal user credentials on this system.
Usage
1
2
$listSystemRoles() Get a list of all users and their roles on this system.
Usage
1
2
$listSystems() Show all systems available to the user.
Usage
1
2
$updateSystem() Update a system description
Usage
1
systems$updateSystem$listSystems(systemId, body, naked, )
$updateSystemCredential() Update an internal user credential on a system.
Usage
1
systems$updateSystemCredential$listSystems(systemId, internalUsername, body, naked, )
$updateSystemCredentialOfType() Add or update a credential of the given type on a system.
Usage
1
systems$updateSystemCredentialOfType$listSystems(systemId, internalUsername, credentialType, body, naked, )
$updateSystemRole() Update a user role on a system.
Usage
1
systems$updateSystemRole$listSystems(systemId, username, body, naked, )
See Also
rAgave::ApiClient rAgave::Agave [rAgave::ExecutionSystem][rAgave::MultipleSystemRoleResponse][rAgave::StorageSystem][rAgave::System][rAgave::SystemAction][rAgave::SystemAuthConfig][rAgave::SystemCredential][rAgave::SystemCredentialsResponse][rAgave::SystemRequest][rAgave::SystemRole][rAgave::SystemRoleRequest][rAgave::SystemSummary]
deardooley/agave-rlang-sdk documentation built on May 17, 2019, 10:12 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Format Details Arguments Methods See Also
Description
SystemsApi Class
Usage
1 | systems <- SystemsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )
|
Format
An object of class R6ClassGenerator of length 24.
Details
A system in Agave represents a server or collection of servers. A server can be physical, virtual, or a collection of servers exposed through a single hostname or ip address. Systems are identified and referenced in Agave by a unique ID unrelated to their ip address or hostname. Because of this, a single physical system may be registered multiple times. This allows different users to configure and use a system in whatever way they need to for their specific needs.
Systems come in two flavors: storage and execution. Storage systems are only used for storing and interacting with data. Execution systems are used for running apps (aka jobs or batch jobs) as well as storing and interacting with data.
The Systems service gives you the ability to add and discover storage and compute resources for use in the rest of the API. You may add as many or as few storage systems as you need to power your digital lab. When you register a system, it is private to you and you alone. Systems can also be published into the public space for all users to use. Depending on who is administering Agave for your organization, this may have already happened and you may already have one or more storage systems available to you by default.
Read more about the Systems API in the Agave Developer's Guide
Arguments
apiClient a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.
cache an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.
responseType the default object type methods of this class should return. Valid values are:
-
raw: the raw JSON string response from the API. You may optionally include
pretty=TRUEin the method call to receive pretty printed JSON. -
list: a standard R list object. This is the default value.
-
dt: a data table
Methods
$addExecutionSystem() Add a new execution system
Usage
1 | systems$addExecutionSystem$listSystems(body, naked, )
|
$addStorageSystem() Add a storage system
Usage
1 | systems$addStorageSystem$listSystems(body, naked, )
|
$addSystemCredential() Add an internal user's credential on a system. This applies both to storage and, if applicable, login credentials.
Usage
1 | systems$addSystemCredential$listSystems(systemId, body, naked, )
|
$addSystemRole() Adds a role on the system for the given user
Usage
1 | systems$addSystemRole$listSystems(systemId, body, naked, )
|
$clearSystemAuthCredentials() Deletes all credentials registered to a system.
Usage
1 | systems$clearSystemAuthCredentials$listSystems(systemId, naked, )
|
$clearSystemAuthCredentialsForInternalUser() Deletes all internal user credentials registered to a system.
Usage
1 | systems$clearSystemAuthCredentialsForInternalUser$listSystems(systemId, internalUsername, naked, )
|
$clearSystemRoles() Deletes all roles on a system.
Usage
1 | systems$clearSystemRoles$listSystems(systemId, naked, )
|
$deleteSystem() Delete a system.
Usage
1 | systems$deleteSystem$listSystems(systemId, naked, )
|
$deleteSystemAuthCredentialForInternalUser() Deletes the internal user credentials for the given credential type on a system.
Usage
1 | systems$deleteSystemAuthCredentialForInternalUser$listSystems(systemId, internalUsername, credentialType, naked, )
|
$deleteSystemRole() Deletes all roles for a user on a system.
Usage
1 | systems$deleteSystemRole$listSystems(systemId, username, naked, )
|
$getSystemCredential() Get the internal user credential of the given type on the system.
Usage
1 2 |
$getSystemDetails() Find information about an individual system.
Usage
1 2 |
$getSystemRole() Get a specific user role on this system.
Usage
1 | systems$getSystemRole$listSystems(systemId, username, naked, )
|
$invokeSystemAction() Perform a management action on the system.
Usage
1 | systems$invokeSystemAction$listSystems(systemId, body, naked, )
|
$listCredentialsForInternalUser() Get a list of all internal users and their credentials on this system.
Usage
1 2 |
$listSystemCredentials() Get a list of all internal user credentials on this system.
Usage
1 2 |
$listSystemRoles() Get a list of all users and their roles on this system.
Usage
1 2 |
$listSystems() Show all systems available to the user.
Usage
1 2 |
$updateSystem() Update a system description
Usage
1 | systems$updateSystem$listSystems(systemId, body, naked, )
|
$updateSystemCredential() Update an internal user credential on a system.
Usage
1 | systems$updateSystemCredential$listSystems(systemId, internalUsername, body, naked, )
|
$updateSystemCredentialOfType() Add or update a credential of the given type on a system.
Usage
1 | systems$updateSystemCredentialOfType$listSystems(systemId, internalUsername, credentialType, body, naked, )
|
$updateSystemRole() Update a user role on a system.
Usage
1 | systems$updateSystemRole$listSystems(systemId, username, body, naked, )
|
See Also
rAgave::ApiClient rAgave::Agave [rAgave::ExecutionSystem][rAgave::MultipleSystemRoleResponse][rAgave::StorageSystem][rAgave::System][rAgave::SystemAction][rAgave::SystemAuthConfig][rAgave::SystemCredential][rAgave::SystemCredentialsResponse][rAgave::SystemRequest][rAgave::SystemRole][rAgave::SystemRoleRequest][rAgave::SystemSummary]
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.