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.



8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
 
# File 'lib/models/porcelain.rb', line 8638

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.



8606
8607
8608
 
# File 'lib/models/porcelain.rb', line 8606

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.



8608
8609
8610
 
# File 'lib/models/porcelain.rb', line 8608

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



8610
8611
8612
 
# File 'lib/models/porcelain.rb', line 8610

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



8612
8613
8614
 
# File 'lib/models/porcelain.rb', line 8612

def healthy
  @healthy
end

#hostname ⇒ Object

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



8614
8615
8616
 
# File 'lib/models/porcelain.rb', line 8614

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



8616
8617
8618
 
# File 'lib/models/porcelain.rb', line 8616

def id
  @id
end

#key_type ⇒ Object

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



8618
8619
8620
 
# File 'lib/models/porcelain.rb', line 8618

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



8620
8621
8622
 
# File 'lib/models/porcelain.rb', line 8620

def name
  @name
end

#port ⇒ Object

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



8622
8623
8624
 
# File 'lib/models/porcelain.rb', line 8622

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



8624
8625
8626
 
# File 'lib/models/porcelain.rb', line 8624

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



8626
8627
8628
 
# File 'lib/models/porcelain.rb', line 8626

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.



8628
8629
8630
 
# File 'lib/models/porcelain.rb', line 8628

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



8630
8631
8632
 
# File 'lib/models/porcelain.rb', line 8630

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)



8632
8633
8634
 
# File 'lib/models/porcelain.rb', line 8632

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8634
8635
8636
 
# File 'lib/models/porcelain.rb', line 8634

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



8636
8637
8638
 
# File 'lib/models/porcelain.rb', line 8636

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8674
8675
8676
8677
8678
8679
8680
 
# File 'lib/models/porcelain.rb', line 8674

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