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.



14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
 
# File 'lib/models/porcelain.rb', line 14914

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.



14880
14881
14882
 
# File 'lib/models/porcelain.rb', line 14880

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



14882
14883
14884
 
# File 'lib/models/porcelain.rb', line 14882

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



14884
14885
14886
 
# File 'lib/models/porcelain.rb', line 14884

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



14886
14887
14888
 
# File 'lib/models/porcelain.rb', line 14886

def healthy
  @healthy
end

#hostname ⇒ Object

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



14888
14889
14890
 
# File 'lib/models/porcelain.rb', line 14888

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



14890
14891
14892
 
# File 'lib/models/porcelain.rb', line 14890

def id
  @id
end

#key_type ⇒ Object

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



14892
14893
14894
 
# File 'lib/models/porcelain.rb', line 14892

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



14894
14895
14896
 
# File 'lib/models/porcelain.rb', line 14894

def name
  @name
end

#port ⇒ Object

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



14896
14897
14898
 
# File 'lib/models/porcelain.rb', line 14896

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



14898
14899
14900
 
# File 'lib/models/porcelain.rb', line 14898

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



14900
14901
14902
 
# File 'lib/models/porcelain.rb', line 14900

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



14902
14903
14904
 
# File 'lib/models/porcelain.rb', line 14902

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.



14904
14905
14906
 
# File 'lib/models/porcelain.rb', line 14904

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



14906
14907
14908
 
# File 'lib/models/porcelain.rb', line 14906

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



14908
14909
14910
 
# File 'lib/models/porcelain.rb', line 14908

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14910
14911
14912
 
# File 'lib/models/porcelain.rb', line 14910

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



14912
14913
14914
 
# File 'lib/models/porcelain.rb', line 14912

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14952
14953
14954
14955
14956
14957
14958
 
# File 'lib/models/porcelain.rb', line 14952

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