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, public_key: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSH

Returns a new instance of SSH.



8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
 
# File 'lib/models/porcelain.rb', line 8486

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,
  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
  @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.



8454
8455
8456
 
# File 'lib/models/porcelain.rb', line 8454

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.



8456
8457
8458
 
# File 'lib/models/porcelain.rb', line 8456

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



8458
8459
8460
 
# File 'lib/models/porcelain.rb', line 8458

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



8460
8461
8462
 
# File 'lib/models/porcelain.rb', line 8460

def healthy
  @healthy
end

#hostname ⇒ Object

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



8462
8463
8464
 
# File 'lib/models/porcelain.rb', line 8462

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



8464
8465
8466
 
# File 'lib/models/porcelain.rb', line 8464

def id
  @id
end

#key_type ⇒ Object

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



8466
8467
8468
 
# File 'lib/models/porcelain.rb', line 8466

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



8468
8469
8470
 
# File 'lib/models/porcelain.rb', line 8468

def name
  @name
end

#port ⇒ Object

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



8470
8471
8472
 
# File 'lib/models/porcelain.rb', line 8470

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



8472
8473
8474
 
# File 'lib/models/porcelain.rb', line 8472

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



8474
8475
8476
 
# File 'lib/models/porcelain.rb', line 8474

def port_override
  @port_override
end

#public_key ⇒ Object

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



8476
8477
8478
 
# File 'lib/models/porcelain.rb', line 8476

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



8478
8479
8480
 
# File 'lib/models/porcelain.rb', line 8478

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)



8480
8481
8482
 
# File 'lib/models/porcelain.rb', line 8480

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8482
8483
8484
 
# File 'lib/models/porcelain.rb', line 8482

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



8484
8485
8486
 
# File 'lib/models/porcelain.rb', line 8484

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8522
8523
8524
8525
8526
8527
8528
 
# File 'lib/models/porcelain.rb', line 8522

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