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, proxy_cluster_id: nil, public_key: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSH

Returns a new instance of SSH.



11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
 
# File 'lib/models/porcelain.rb', line 11853

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,
  proxy_cluster_id: 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
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @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.



11819
11820
11821
 
# File 'lib/models/porcelain.rb', line 11819

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.



11821
11822
11823
 
# File 'lib/models/porcelain.rb', line 11821

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



11823
11824
11825
 
# File 'lib/models/porcelain.rb', line 11823

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



11825
11826
11827
 
# File 'lib/models/porcelain.rb', line 11825

def healthy
  @healthy
end

#hostname ⇒ Object

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



11827
11828
11829
 
# File 'lib/models/porcelain.rb', line 11827

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



11829
11830
11831
 
# File 'lib/models/porcelain.rb', line 11829

def id
  @id
end

#key_type ⇒ Object

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



11831
11832
11833
 
# File 'lib/models/porcelain.rb', line 11831

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



11833
11834
11835
 
# File 'lib/models/porcelain.rb', line 11833

def name
  @name
end

#port ⇒ Object

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



11835
11836
11837
 
# File 'lib/models/porcelain.rb', line 11835

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



11837
11838
11839
 
# File 'lib/models/porcelain.rb', line 11837

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



11839
11840
11841
 
# File 'lib/models/porcelain.rb', line 11839

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

ID of the proxy cluster for this resource, if any.



11841
11842
11843
 
# File 'lib/models/porcelain.rb', line 11841

def proxy_cluster_id
  @proxy_cluster_id
end

#public_key ⇒ Object

The public key to append to a server's authorized keys. This will be generated after resource creation.



11843
11844
11845
 
# File 'lib/models/porcelain.rb', line 11843

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



11845
11846
11847
 
# File 'lib/models/porcelain.rb', line 11845

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)



11847
11848
11849
 
# File 'lib/models/porcelain.rb', line 11847

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11849
11850
11851
 
# File 'lib/models/porcelain.rb', line 11849

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



11851
11852
11853
 
# File 'lib/models/porcelain.rb', line 11851

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11891
11892
11893
11894
11895
11896
11897
 
# File 'lib/models/porcelain.rb', line 11891

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