Skip to main content

SshCredentials

############################################################### SSH ###############################################################

type SshCredentials implements CredentialsBase {
id: ID!
key: String
shared: Boolean!
canDecrypt: Boolean
system: MonitoredSystem
purpose: CredentialsPurpose
hostname: String
port: Int
username: String
password: String
identity: String
identityPassphrase: String
config: [Property]
}

Fields

SshCredentials.id ● ID! non-null scalar

This credentials ID

SshCredentials.key ● String scalar

Identifies to credentials with a purpose and should be used in set... and delete.. credential operations.

SshCredentials.shared ● Boolean! non-null scalar

The shared flag (true for global credentials)

SshCredentials.canDecrypt ● Boolean scalar

SshCredentials.system ● MonitoredSystem interface

If there is a monitored system associated this field can return it.

SshCredentials.purpose ● CredentialsPurpose object

The purpose of this credentials.

SshCredentials.hostname ● String scalar

The hostname to connect to. If it is empty the hostname of the monitoring server is used.

SshCredentials.port ● Int scalar

The port to connect to. If it is empty the default SSH port 22 will be used.

SshCredentials.username ● String scalar

The SSH username

SshCredentials.password ● String scalar

The password.

SshCredentials.identity ● String scalar

Identity (private key) for public key authentication.

SshCredentials.identityPassphrase ● String scalar

Identity (private key) passphrase for public key authentication.

SshCredentials.config ● [Property] list object

SSH configuration options in the shape "key" -> "value" pairs.

Interfaces

CredentialsBase interface

Member Of

CreateSshCredentialsPayload object ● SetSshCredentialsPayload object ● UpdateSshCredentialsPayload object