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.



8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
 
# File 'lib/models/porcelain.rb', line 8796

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.



8764
8765
8766
 
# File 'lib/models/porcelain.rb', line 8764

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.



8766
8767
8768
 
# File 'lib/models/porcelain.rb', line 8766

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



8768
8769
8770
 
# File 'lib/models/porcelain.rb', line 8768

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



8770
8771
8772
 
# File 'lib/models/porcelain.rb', line 8770

def healthy
  @healthy
end

#hostname ⇒ Object

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



8772
8773
8774
 
# File 'lib/models/porcelain.rb', line 8772

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



8774
8775
8776
 
# File 'lib/models/porcelain.rb', line 8774

def id
  @id
end

#key_type ⇒ Object

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



8776
8777
8778
 
# File 'lib/models/porcelain.rb', line 8776

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



8778
8779
8780
 
# File 'lib/models/porcelain.rb', line 8778

def name
  @name
end

#port ⇒ Object

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



8780
8781
8782
 
# File 'lib/models/porcelain.rb', line 8780

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



8782
8783
8784
 
# File 'lib/models/porcelain.rb', line 8782

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



8784
8785
8786
 
# File 'lib/models/porcelain.rb', line 8784

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.



8786
8787
8788
 
# File 'lib/models/porcelain.rb', line 8786

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



8788
8789
8790
 
# File 'lib/models/porcelain.rb', line 8788

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)



8790
8791
8792
 
# File 'lib/models/porcelain.rb', line 8790

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8792
8793
8794
 
# File 'lib/models/porcelain.rb', line 8792

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



8794
8795
8796
 
# File 'lib/models/porcelain.rb', line 8794

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8832
8833
8834
8835
8836
8837
8838
 
# File 'lib/models/porcelain.rb', line 8832

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