SetupSshKey (Payara Project 6.2023.2 API)

java.lang.Object
- com.sun.enterprise.admin.cli.CLICommand
- - com.sun.enterprise.admin.cli.cluster.SetupSshKey

All Implemented Interfaces:

org.glassfish.hk2.api.PostConstruct
```
@Service(name="setup-ssh")
@PerLookup
@ExecuteOn(DAS)
public final class SetupSshKey
extends CLICommand
```
This is a local command that distributes the SSH public key to remote node(s)

Field Summary
- Fields inherited from class com.sun.enterprise.admin.cli.CLICommand
  argv, ASADMIN, commandModel, CONNECTION_ERROR, env, ERROR, INVALID_COMMAND_ERROR, lineReader, logger, metadataErrors, name, operands, options, passwords, programOpts, SUCCESS, terminal, WARNING

Constructor Summary

Constructors
Constructor Description

SetupSshKey()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected int`	`executeCommand()`	Execute the command using the options in options and the operands in operands.
`protected void`	`validate()`	The validate method can be used by a subclass to validate that the type and quantity of parameters and operands matches the requirements for this command.

Methods inherited from class com.sun.enterprise.admin.cli.CLICommand
buildLineReader, buildTerminal, checkHelp, closeTerminal, execute, execute, expandManPage, getBooleanOption, getBriefCommandUsage, getCommand, getCommand, getCommandScope, getCommandUsage, getManPage, getName, getOperandModel, getOption, getOptions, getPassword, getPassword, getProgramOptions, getSystemProperties, getSystemProperty, getUsage, initializeLogger, initializePasswords, inject, newLineReaderBuilder, ok, parse, postConstruct, prepare, prevalidate, printExceptionStackTrace, processProgramOptions, quote, readPassword, setCommandScope, toString, usageOptions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SetupSshKey
```
public SetupSshKey()
```
- Method Detail
  - validate
```
protected void validate()
                 throws CommandException
```
    Description copied from class: CLICommand
    
    The validate method can be used by a subclass to validate that the type and quantity of parameters and operands matches the requirements for this command.
    
    Throws:
    
    CommandException - if execution of the command fails
    
    CommandValidationException - if there's something wrong with the options or arguments
  - executeCommand
```
protected int executeCommand()
                      throws CommandException
```
    Description copied from class: CLICommand
    
    Execute the command using the options in options and the operands in operands.
    
    Specified by:
    
    executeCommand in class CLICommand
    
    Returns:
    
    the exit code
    
    Throws:
    
    CommandException - if execution of the command fails
    
    CommandValidationException - if there's something wrong with the options or arguments