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.



8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
 
# File 'lib/models/porcelain.rb', line 8911

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.



8879
8880
8881
 
# File 'lib/models/porcelain.rb', line 8879

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.



8881
8882
8883
 
# File 'lib/models/porcelain.rb', line 8881

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



8883
8884
8885
 
# File 'lib/models/porcelain.rb', line 8883

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



8885
8886
8887
 
# File 'lib/models/porcelain.rb', line 8885

def healthy
  @healthy
end

#hostname ⇒ Object

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



8887
8888
8889
 
# File 'lib/models/porcelain.rb', line 8887

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



8889
8890
8891
 
# File 'lib/models/porcelain.rb', line 8889

def id
  @id
end

#key_type ⇒ Object

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



8891
8892
8893
 
# File 'lib/models/porcelain.rb', line 8891

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



8893
8894
8895
 
# File 'lib/models/porcelain.rb', line 8893

def name
  @name
end

#port ⇒ Object

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



8895
8896
8897
 
# File 'lib/models/porcelain.rb', line 8895

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



8897
8898
8899
 
# File 'lib/models/porcelain.rb', line 8897

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



8899
8900
8901
 
# File 'lib/models/porcelain.rb', line 8899

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.



8901
8902
8903
 
# File 'lib/models/porcelain.rb', line 8901

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



8903
8904
8905
 
# File 'lib/models/porcelain.rb', line 8903

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)



8905
8906
8907
 
# File 'lib/models/porcelain.rb', line 8905

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8907
8908
8909
 
# File 'lib/models/porcelain.rb', line 8907

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



8909
8910
8911
 
# File 'lib/models/porcelain.rb', line 8909

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8947
8948
8949
8950
8951
8952
8953
 
# File 'lib/models/porcelain.rb', line 8947

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