Class: SDM::SSH

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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.



11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
 
# File 'lib/models/porcelain.rb', line 11237

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.



11203
11204
11205
 
# File 'lib/models/porcelain.rb', line 11203

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.



11205
11206
11207
 
# File 'lib/models/porcelain.rb', line 11205

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



11207
11208
11209
 
# File 'lib/models/porcelain.rb', line 11207

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



11209
11210
11211
 
# File 'lib/models/porcelain.rb', line 11209

def healthy
  @healthy
end

#hostname ⇒ Object

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



11211
11212
11213
 
# File 'lib/models/porcelain.rb', line 11211

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



11213
11214
11215
 
# File 'lib/models/porcelain.rb', line 11213

def id
  @id
end

#key_type ⇒ Object

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



11215
11216
11217
 
# File 'lib/models/porcelain.rb', line 11215

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



11217
11218
11219
 
# File 'lib/models/porcelain.rb', line 11217

def name
  @name
end

#port ⇒ Object

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



11219
11220
11221
 
# File 'lib/models/porcelain.rb', line 11219

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



11221
11222
11223
 
# File 'lib/models/porcelain.rb', line 11221

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



11223
11224
11225
 
# File 'lib/models/porcelain.rb', line 11223

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



11225
11226
11227
 
# File 'lib/models/porcelain.rb', line 11225

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.



11227
11228
11229
 
# File 'lib/models/porcelain.rb', line 11227

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



11229
11230
11231
 
# File 'lib/models/porcelain.rb', line 11229

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



11231
11232
11233
 
# File 'lib/models/porcelain.rb', line 11231

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11233
11234
11235
 
# File 'lib/models/porcelain.rb', line 11233

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



11235
11236
11237
 
# File 'lib/models/porcelain.rb', line 11235

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11275
11276
11277
11278
11279
11280
11281
 
# File 'lib/models/porcelain.rb', line 11275

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