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.



8485
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
 
# File 'lib/models/porcelain.rb', line 8485

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.



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

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.



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

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



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

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



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

def healthy
  @healthy
end

#hostname ⇒ Object

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



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

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



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

def id
  @id
end

#key_type ⇒ Object

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



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

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



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

def name
  @name
end

#port ⇒ Object

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



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

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



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

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



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

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.



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

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



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

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)



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

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



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

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



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

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



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

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