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.



13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
 
# File 'lib/models/porcelain.rb', line 13318

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.



13284
13285
13286
 
# File 'lib/models/porcelain.rb', line 13284

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.



13286
13287
13288
 
# File 'lib/models/porcelain.rb', line 13286

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



13288
13289
13290
 
# File 'lib/models/porcelain.rb', line 13288

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



13290
13291
13292
 
# File 'lib/models/porcelain.rb', line 13290

def healthy
  @healthy
end

#hostname ⇒ Object

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



13292
13293
13294
 
# File 'lib/models/porcelain.rb', line 13292

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



13294
13295
13296
 
# File 'lib/models/porcelain.rb', line 13294

def id
  @id
end

#key_type ⇒ Object

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



13296
13297
13298
 
# File 'lib/models/porcelain.rb', line 13296

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



13298
13299
13300
 
# File 'lib/models/porcelain.rb', line 13298

def name
  @name
end

#port ⇒ Object

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



13300
13301
13302
 
# File 'lib/models/porcelain.rb', line 13300

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



13302
13303
13304
 
# File 'lib/models/porcelain.rb', line 13302

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



13304
13305
13306
 
# File 'lib/models/porcelain.rb', line 13304

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



13306
13307
13308
 
# File 'lib/models/porcelain.rb', line 13306

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.



13308
13309
13310
 
# File 'lib/models/porcelain.rb', line 13308

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



13310
13311
13312
 
# File 'lib/models/porcelain.rb', line 13310

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)



13312
13313
13314
 
# File 'lib/models/porcelain.rb', line 13312

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13314
13315
13316
 
# File 'lib/models/porcelain.rb', line 13314

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



13316
13317
13318
 
# File 'lib/models/porcelain.rb', line 13316

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13356
13357
13358
13359
13360
13361
13362
 
# File 'lib/models/porcelain.rb', line 13356

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