| Property | Type | Description | |
|---|---|---|---|
| $cloudKeyName | string | Name of Ssh Key in cloud | |
| $cloudLocation | string | Cloud Location | |
| $envId | integer | The identifier of the client's environment | |
| $farmId | integer | The identifier of the farm | |
| $id | integer | The identifier of Ssh Key | |
| $platform | string | Platform | |
| $privateKey | string | Private Key | |
| $publicKey | string | Public Key | |
| $type | string | Type of Ssh key |
| Method | Description | |
|---|---|---|
| generateKeypair ( ) : array | Generate private and public key | |
| generatePublicKey ( ) : string | Generate public key | |
| getEnvironmentPlatforms ( $envId ) : array | Get list of platforms where ssh keys are available on environment | |
| getPuttyPrivateKey ( ) : string | Convert private key to putty format | |
| hasAccessPermissions ( $user, $environment = null, $modify = null ) | ||
| isUsed ( ) : boolean | Check if key is used by any farm role | |
|
loadGlobalByFarmId ( integer $envId, string $platform, string $cloudLocation, integer $farmId = null ) : |
Find global key by FarmID | |
|
loadGlobalByName ( integer $envId, string $platform, string $cloudLocation, string $name ) : |
Find global key by Name |
| Method | Description | |
|---|---|---|
| getSshKeygenValue ( array $args, string $tmpFileContents, boolean $readTmpFile = false ) : string | External call to ssh-keygen utility |
| public generateKeypair ( ) : array | ||
| return | array | |
| public generatePublicKey ( ) : string | ||
| return | string | |
| public getEnvironmentPlatforms ( $envId ) : array | ||
| $envId | ||
| return | array | |
| public getPuttyPrivateKey ( ) : string | ||
| return | string | |
| public hasAccessPermissions ( $user, $environment = null, $modify = null ) |
| public int $envId | ||
| return | integer | |