Package com.strongdm.api

Class SSH

java.lang.Object
com.strongdm.api.SSH
All Implemented Interfaces:
Resource
public class SSH extends Object implements Resource

  • Constructor Summary

    Constructors
    Constructor
    Description
    SSH()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAllowDeprecatedKeyExchanges()
    Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.
    String
    getBindInterface()
    The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1).
    String
    getEgressFilter()
    A filter applied to the routing logic to pin datasource to nodes.
    boolean
    getHealthy()
    True if the datasource is reachable and the credentials are valid.
    String
    getHostname()
    The host to dial to initiate a connection from the egress node to this resource.
    String
    getId()
    Unique identifier of the Resource.
    String
    getKeyType()
    The key type to use e.g.
    boolean
    getLockRequired()
    When set, require a resource lock to access the resource to ensure it can only be used by one user at a time.
    String
    getName()
    Unique human-readable name of the Resource.
    int
    getPort()
    The port to dial to initiate a connection from the egress node to this resource.
    boolean
    getPortForwarding()
    Whether port forwarding is allowed through this server.
    int
    getPortOverride()
    The local port used by clients to connect to this resource.
    String
    getProxyClusterId()
    ID of the proxy cluster for this resource, if any.
    String
    getPublicKey()
    The public key to append to a server's authorized keys.
    String
    getSecretStoreId()
    ID of the secret store containing credentials for this resource, if any.
    String
    getSubdomain()
    DNS subdomain through which this resource may be accessed on clients.
    Map<String,String>
    getTags()
    Tags is a map of key, value pairs.
    String
    getUsername()
    The username to authenticate with.
    void
    setAllowDeprecatedKeyExchanges(boolean in)
    Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.
    void
    setBindInterface(String in)
    The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1).
    void
    setEgressFilter(String in)
    A filter applied to the routing logic to pin datasource to nodes.
    void
    setHealthy(boolean in)
    True if the datasource is reachable and the credentials are valid.
    void
    setHostname(String in)
    The host to dial to initiate a connection from the egress node to this resource.
    void
    setId(String in)
    Unique identifier of the Resource.
    void
    setKeyType(String in)
    The key type to use e.g.
    void
    setLockRequired(boolean in)
    When set, require a resource lock to access the resource to ensure it can only be used by one user at a time.
    void
    setName(String in)
    Unique human-readable name of the Resource.
    void
    setPort(int in)
    The port to dial to initiate a connection from the egress node to this resource.
    void
    setPortForwarding(boolean in)
    Whether port forwarding is allowed through this server.
    void
    setPortOverride(int in)
    The local port used by clients to connect to this resource.
    void
    setProxyClusterId(String in)
    ID of the proxy cluster for this resource, if any.
    void
    setPublicKey(String in)
    The public key to append to a server's authorized keys.
    void
    setSecretStoreId(String in)
    ID of the secret store containing credentials for this resource, if any.
    void
    setSubdomain(String in)
    DNS subdomain through which this resource may be accessed on clients.
    void
    setTags(Map<String,String> in)
    Tags is a map of key, value pairs.
    void
    setUsername(String in)
    The username to authenticate with.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SSH

      public SSH()

  • Method Details

    • getAllowDeprecatedKeyExchanges

      public boolean getAllowDeprecatedKeyExchanges()
      Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.

    • setAllowDeprecatedKeyExchanges

      public void setAllowDeprecatedKeyExchanges(boolean in)
      Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.

    • getBindInterface

      public String getBindInterface()
      The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.
      Specified by:
      getBindInterface in interface Resource

    • setBindInterface

      public void setBindInterface(String in)
      The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.
      Specified by:
      setBindInterface in interface Resource

    • getEgressFilter

      public String getEgressFilter()
      A filter applied to the routing logic to pin datasource to nodes.
      Specified by:
      getEgressFilter in interface Resource

    • setEgressFilter

      public void setEgressFilter(String in)
      A filter applied to the routing logic to pin datasource to nodes.
      Specified by:
      setEgressFilter in interface Resource

    • getHealthy

      public boolean getHealthy()
      True if the datasource is reachable and the credentials are valid.

    • setHealthy

      public void setHealthy(boolean in)
      True if the datasource is reachable and the credentials are valid.

    • getHostname

      public String getHostname()
      The host to dial to initiate a connection from the egress node to this resource.

    • setHostname

      public void setHostname(String in)
      The host to dial to initiate a connection from the egress node to this resource.

    • getId

      public String getId()
      Unique identifier of the Resource.
      Specified by:
      getId in interface Resource

    • setId

      public void setId(String in)
      Unique identifier of the Resource.

    • getKeyType

      public String getKeyType()
      The key type to use e.g. rsa-2048 or ed25519

    • setKeyType

      public void setKeyType(String in)
      The key type to use e.g. rsa-2048 or ed25519

    • getLockRequired

      public boolean getLockRequired()
      When set, require a resource lock to access the resource to ensure it can only be used by one user at a time.

    • setLockRequired

      public void setLockRequired(boolean in)
      When set, require a resource lock to access the resource to ensure it can only be used by one user at a time.

    • getName

      public String getName()
      Unique human-readable name of the Resource.
      Specified by:
      getName in interface Resource

    • setName

      public void setName(String in)
      Unique human-readable name of the Resource.
      Specified by:
      setName in interface Resource

    • getPort

      public int getPort()
      The port to dial to initiate a connection from the egress node to this resource.

    • setPort

      public void setPort(int in)
      The port to dial to initiate a connection from the egress node to this resource.

    • getPortForwarding

      public boolean getPortForwarding()
      Whether port forwarding is allowed through this server.

    • setPortForwarding

      public void setPortForwarding(boolean in)
      Whether port forwarding is allowed through this server.

    • getPortOverride

      public int getPortOverride()
      The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.

    • setPortOverride

      public void setPortOverride(int in)
      The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.

    • getProxyClusterId

      public String getProxyClusterId()
      ID of the proxy cluster for this resource, if any.

    • setProxyClusterId

      public void setProxyClusterId(String in)
      ID of the proxy cluster for this resource, if any.

    • getPublicKey

      public String getPublicKey()
      The public key to append to a server's authorized keys. This will be generated after resource creation.

    • setPublicKey

      public void setPublicKey(String in)
      The public key to append to a server's authorized keys. This will be generated after resource creation.

    • getSecretStoreId

      public String getSecretStoreId()
      ID of the secret store containing credentials for this resource, if any.
      Specified by:
      getSecretStoreId in interface Resource

    • setSecretStoreId

      public void setSecretStoreId(String in)
      ID of the secret store containing credentials for this resource, if any.
      Specified by:
      setSecretStoreId in interface Resource

    • getSubdomain

      public String getSubdomain()
      DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.

    • setSubdomain

      public void setSubdomain(String in)
      DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.

    • getTags

      public Map<String,String> getTags()
      Tags is a map of key, value pairs.
      Specified by:
      getTags in interface Resource

    • setTags

      public void setTags(Map<String,String> in)
      Tags is a map of key, value pairs.
      Specified by:
      setTags in interface Resource

    • getUsername

      public String getUsername()
      The username to authenticate with.

    • setUsername

      public void setUsername(String in)
      The username to authenticate with.