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.



13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
 
# File 'lib/models/porcelain.rb', line 13426

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.



13392
13393
13394
 
# File 'lib/models/porcelain.rb', line 13392

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.



13394
13395
13396
 
# File 'lib/models/porcelain.rb', line 13394

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



13396
13397
13398
 
# File 'lib/models/porcelain.rb', line 13396

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



13398
13399
13400
 
# File 'lib/models/porcelain.rb', line 13398

def healthy
  @healthy
end

#hostname ⇒ Object

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



13400
13401
13402
 
# File 'lib/models/porcelain.rb', line 13400

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



13402
13403
13404
 
# File 'lib/models/porcelain.rb', line 13402

def id
  @id
end

#key_type ⇒ Object

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



13404
13405
13406
 
# File 'lib/models/porcelain.rb', line 13404

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



13406
13407
13408
 
# File 'lib/models/porcelain.rb', line 13406

def name
  @name
end

#port ⇒ Object

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



13408
13409
13410
 
# File 'lib/models/porcelain.rb', line 13408

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



13410
13411
13412
 
# File 'lib/models/porcelain.rb', line 13410

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



13412
13413
13414
 
# File 'lib/models/porcelain.rb', line 13412

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



13414
13415
13416
 
# File 'lib/models/porcelain.rb', line 13414

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.



13416
13417
13418
 
# File 'lib/models/porcelain.rb', line 13416

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



13418
13419
13420
 
# File 'lib/models/porcelain.rb', line 13418

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)



13420
13421
13422
 
# File 'lib/models/porcelain.rb', line 13420

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13422
13423
13424
 
# File 'lib/models/porcelain.rb', line 13422

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



13424
13425
13426
 
# File 'lib/models/porcelain.rb', line 13424

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13464
13465
13466
13467
13468
13469
13470
 
# File 'lib/models/porcelain.rb', line 13464

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