Class: SDM::SSHPassword

Inherits:

Object

• Object
• SDM::SSHPassword

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.

• #lock_required ⇒ Object

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

• #name ⇒ Object

  Unique human-readable name of the Resource.

• #password ⇒ Object

  The password to authenticate with.

• #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.

• #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, lock_required: nil, name: nil, password: nil, port: nil, port_forwarding: nil, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSHPassword constructor

  A new instance of SSHPassword.

• #to_json(options = {}) ⇒ Object

Constructor Details

#initialize(allow_deprecated_key_exchanges: nil, bind_interface: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, lock_required: nil, name: nil, password: nil, port: nil, port_forwarding: nil, port_override: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSHPassword

Returns a new instance of SSHPassword.

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

def initialize(
  allow_deprecated_key_exchanges: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  lock_required: nil,
  name: nil,
  password: nil,
  port: nil,
  port_forwarding: nil,
  port_override: nil,
  proxy_cluster_id: 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
  @lock_required = lock_required == nil ? false : lock_required
  @name = name == nil ? "" : name
  @password = password == nil ? "" : password
  @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
  @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 16203

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 16205

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 16207

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 16209

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 16211

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.

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

def id
  @id
end

#lock_required ⇒ Object

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

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

def lock_required
  @lock_required
end

#name ⇒ Object

Unique human-readable name of the Resource.

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

def name
  @name
end

#password ⇒ Object

The password to authenticate with.

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

def password
  @password
end

#port ⇒ Object

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

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

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.

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

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 16225

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 16227

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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

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

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 16231

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.

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

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.

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

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object

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

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