CLI cookbook: adding a UNIX host

This topic describes the process of adding a UNIX host using the 3.0 command-line interface.

Within Delphix, there are both hosts and host environments. A host represents a remote system, but may or may not be a source or target for linking or provisioning. For example, in an Oracle RAC cluster, the cluster environment represents the location of the Oracle installation(s), and while there are hosts within that cluster they are not individually manageable as environments.

Procedure

Create a new environment and set the parameter type to be a UNIX host.

CODE

delphix> environment create
delphix environment create *> set type=HostEnvironmentCreateParameters
delphix environment create *> set hostEnvironment.type=UnixHostEnvironment
delphix environment create *> set hostParameters.type=UnixHostCreateParameters
delphix environment create *> set primaryUser.credential.type=PasswordCredential
delphix environment create *> get
    type: HostEnvironmentCreateParameters
    hostEnvironment:
        type: UnixHostEnvironment
        name: (unset)
        aseHostEnvironmentParameters: (unset)
        description: (unset)
        logCollectionEnabled: false
    hostParameters:
        type: UnixHostCreateParameters
        host:
            type: UnixHost
            address: (required)
            dspKeystoreAlias: (unset)
            dspKeystorePassword: (unset)
            dspKeystorePath: (unset)
            dspTruststorePassword: (unset)
            dspTruststorePath: (unset)
            javaHome: (unset)
            nfsAddressList: (unset)
            oracleJdbcKeystorePassword: (unset)
            privilegeElevationProfile: (unset)
            sshPort: 22
            sshVerificationStrategy: (unset)
            toolkitPath: (required)
    logCollectionEnabled: false
    primaryUser:
        type: EnvironmentUser
        name: (unset)
        credential:
            type: PasswordCredential
            password: (required)
        environment: (unset)
        groupId: (unset)
        userId: (unset)

Set the host address. The name of the environment is derived from the address used, though you can provide a more descriptive name if desired. The address can be DNS names, IP addresses, or a comma-separated list of the above.
CODE
```
delphix environment create *> set hostParameters.host.address=192.168.1.2
```
Set the toolkit path. This is where Delphix will store temporary binaries used while the host is configured as part of Delphix.
CODE
```
delphix environment create *> set hostParameters.host.toolkitPath=/work
```
Set the username and password to use when connecting over SSH. This user must have the privileges described in the Delphix Administration Guide. To configure an SSH user, change the credential type to SystemKeyCredential.
CODE
```
delphix environment create *> set primaryUser.name=oracle
delphix environment create *> set primaryUser.credential.password
Enter primaryUser.credential.password: *******
```

Commit the result. The environment discovery process will execute as an asynchronous job. The default behavior is to wait for the result, so progress will be updated until the discovery process is complete or fails.

CODE

delphix environment create *> commit
    UNIX_HOST_ENVIRONMENT-4
    Dispatched job JOB-39
    ENVIRONMENT_CREATE_AND_DISCOVER job started for "192.168.1.2".
    ENVIRONMENT_CREATE_AND_DISCOVER job for "192.168.1.2" completed successfully.
delphix>