Package api.equinix.javasdk.networkedge.client

Interface SSHUsers

All Known Implementing Classes:

SSHUsersImpl

public interface SSHUsers

Client interface for managing SSH users on Network Edge devices. Provides operations to list, retrieve, and create SSH users, as well as check username availability.

Version:

$Id: $Id

Author:

ianjones

Method Summary

Modifier and Type	Method	Description
Boolean	checkUsernameAvailability(String username)	Returns true if the username is available, otherwise returns 400 bad request.
SSHUserOperator.SSHUserBuilder	define(String username, String password, String deviceUuid)	Returns an instance of SSHUserBuilder for defining a new SSH User.
SSHUser	getByUuid(String uuid)	Gets the specified SSH User.
PaginatedList<SSHUser>	list()	Lists available SSH Users.
PaginatedList<SSHUser>	list(RequestBuilder.SSHUser requestBuilder)	Lists SSH Users based on the parameters provided.

Method Details

list

PaginatedList<SSHUser> list()

Lists available SSH Users.

Returns:

PaginatedList

list

PaginatedList<SSHUser> list(RequestBuilder.SSHUser requestBuilder)

Lists SSH Users based on the parameters provided.

Parameters:

requestBuilder - the desired query parameters.

Returns:

PaginatedList

getByUuid

SSHUser getByUuid(String uuid)

Gets the specified SSH User.

Parameters:

uuid - the unique identifier of the SSH User.

Returns:

SSHUser

define

SSHUserOperator.SSHUserBuilder define(String username,
 String password,
 String deviceUuid)

Returns an instance of SSHUserBuilder for defining a new SSH User.

Parameters:

username - the username for the new SSH User.

password - the password for the new SSH User.

deviceUuid - the unique identifier of the device to add the SSH User to.

Returns:

SSHUserOperator.SSHUserBuilder

checkUsernameAvailability

Boolean checkUsernameAvailability(String username)

Returns true if the username is available, otherwise returns 400 bad request.

Parameters:

username - the username to check the availability of.

Returns:

Boolean