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.



9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
 
# File 'lib/models/porcelain.rb', line 9511

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.



9479
9480
9481
 
# File 'lib/models/porcelain.rb', line 9479

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.



9481
9482
9483
 
# File 'lib/models/porcelain.rb', line 9481

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



9483
9484
9485
 
# File 'lib/models/porcelain.rb', line 9483

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



9485
9486
9487
 
# File 'lib/models/porcelain.rb', line 9485

def healthy
  @healthy
end

#hostname ⇒ Object

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



9487
9488
9489
 
# File 'lib/models/porcelain.rb', line 9487

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



9489
9490
9491
 
# File 'lib/models/porcelain.rb', line 9489

def id
  @id
end

#key_type ⇒ Object

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



9491
9492
9493
 
# File 'lib/models/porcelain.rb', line 9491

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



9493
9494
9495
 
# File 'lib/models/porcelain.rb', line 9493

def name
  @name
end

#port ⇒ Object

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



9495
9496
9497
 
# File 'lib/models/porcelain.rb', line 9495

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



9497
9498
9499
 
# File 'lib/models/porcelain.rb', line 9497

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



9499
9500
9501
 
# File 'lib/models/porcelain.rb', line 9499

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.



9501
9502
9503
 
# File 'lib/models/porcelain.rb', line 9501

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



9503
9504
9505
 
# File 'lib/models/porcelain.rb', line 9503

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)



9505
9506
9507
 
# File 'lib/models/porcelain.rb', line 9505

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



9507
9508
9509
 
# File 'lib/models/porcelain.rb', line 9507

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



9509
9510
9511
 
# File 'lib/models/porcelain.rb', line 9509

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9547
9548
9549
9550
9551
9552
9553
 
# File 'lib/models/porcelain.rb', line 9547

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