Class: SDM::SSH

Inherits:

Object

• Object
• SDM::SSH

Defined in:

lib/models/porcelain.rb

Instance Attribute Summary

• #allow_deprecated_key_exchanges ⇒ Object

  Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.

• #bind_interface ⇒ Object

  The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1).

• #egress_filter ⇒ Object

  A filter applied to the routing logic to pin datasource to nodes.

• #healthy ⇒ Object

  True if the datasource is reachable and the credentials are valid.

• #hostname ⇒ Object

  The host to dial to initiate a connection from the egress node to this resource.

• #id ⇒ Object

  Unique identifier of the Resource.

• #key_type ⇒ Object

  The key type to use e.g.

• #name ⇒ Object

  Unique human-readable name of the Resource.

• #port ⇒ Object

  The port to dial to initiate a connection from the egress node to this resource.

• #port_forwarding ⇒ Object

  Whether port forwarding is allowed through this server.

• #port_override ⇒ Object

  The local port used by clients to connect to this resource.

• #proxy_cluster_id ⇒ Object

  ID of the proxy cluster for this resource, if any.

• #public_key ⇒ Object

  The public key to append to a server's authorized keys.

• #secret_store_id ⇒ Object

  ID of the secret store containing credentials for this resource, if any.

• #subdomain ⇒ Object

  DNS subdomain through which this resource may be accessed on clients.

• #tags ⇒ Object

  Tags is a map of key, value pairs.

• #username ⇒ Object

  The username to authenticate with.

Instance Method Summary

• #initialize(allow_deprecated_key_exchanges: nil, bind_interface: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, key_type: nil, name: nil, port: nil, port_forwarding: nil, port_override: nil, proxy_cluster_id: nil, public_key: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSH constructor

  A new instance of SSH.

• #to_json(options = {}) ⇒ Object

Constructor Details

#initialize(allow_deprecated_key_exchanges: nil, bind_interface: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, key_type: nil, name: nil, port: nil, port_forwarding: nil, port_override: nil, proxy_cluster_id: nil, public_key: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSH

Returns a new instance of SSH.

# File 'lib/models/porcelain.rb', line 14706

def initialize(
  allow_deprecated_key_exchanges: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  key_type: nil,
  name: nil,
  port: nil,
  port_forwarding: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  public_key: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @allow_deprecated_key_exchanges = allow_deprecated_key_exchanges == nil ? false : allow_deprecated_key_exchanges
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @key_type = key_type == nil ? "" : key_type
  @name = name == nil ? "" : name
  @port = port == nil ? 0 : port
  @port_forwarding = port_forwarding == nil ? false : port_forwarding
  @port_override = port_override == nil ? 0 : port_override
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @public_key = public_key == nil ? "" : public_key
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#allow_deprecated_key_exchanges ⇒ Object

Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.

# File 'lib/models/porcelain.rb', line 14672

def allow_deprecated_key_exchanges
  @allow_deprecated_key_exchanges
end

#bind_interface ⇒ Object

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.

# File 'lib/models/porcelain.rb', line 14674

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

A filter applied to the routing logic to pin datasource to nodes.

# File 'lib/models/porcelain.rb', line 14676

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

True if the datasource is reachable and the credentials are valid.

# File 'lib/models/porcelain.rb', line 14678

def healthy
  @healthy
end

#hostname ⇒ Object

The host to dial to initiate a connection from the egress node to this resource.

# File 'lib/models/porcelain.rb', line 14680

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.

# File 'lib/models/porcelain.rb', line 14682

def id
  @id
end

#key_type ⇒ Object

The key type to use e.g. rsa-2048 or ed25519

# File 'lib/models/porcelain.rb', line 14684

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.

# File 'lib/models/porcelain.rb', line 14686

def name
  @name
end

#port ⇒ Object

The port to dial to initiate a connection from the egress node to this resource.

# File 'lib/models/porcelain.rb', line 14688

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.

# File 'lib/models/porcelain.rb', line 14690

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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.

# File 'lib/models/porcelain.rb', line 14692

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

ID of the proxy cluster for this resource, if any.

# File 'lib/models/porcelain.rb', line 14694

def proxy_cluster_id
  @proxy_cluster_id
end

#public_key ⇒ Object

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

# File 'lib/models/porcelain.rb', line 14696

def public_key
  @public_key
end

#secret_store_id ⇒ Object

ID of the secret store containing credentials for this resource, if any.

# File 'lib/models/porcelain.rb', line 14698

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

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.

# File 'lib/models/porcelain.rb', line 14700

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.

# File 'lib/models/porcelain.rb', line 14702

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.

# File 'lib/models/porcelain.rb', line 14704

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object

# File 'lib/models/porcelain.rb', line 14744

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end