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, lock_required: 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.



15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
 
# File 'lib/models/porcelain.rb', line 15880

def initialize(
  allow_deprecated_key_exchanges: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  key_type: nil,
  lock_required: 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
  @lock_required = lock_required == nil ? false : lock_required
  @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.



15844
15845
15846
 
# File 'lib/models/porcelain.rb', line 15844

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.



15846
15847
15848
 
# File 'lib/models/porcelain.rb', line 15846

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



15848
15849
15850
 
# File 'lib/models/porcelain.rb', line 15848

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



15850
15851
15852
 
# File 'lib/models/porcelain.rb', line 15850

def healthy
  @healthy
end

#hostname ⇒ Object

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



15852
15853
15854
 
# File 'lib/models/porcelain.rb', line 15852

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



15854
15855
15856
 
# File 'lib/models/porcelain.rb', line 15854

def id
  @id
end

#key_type ⇒ Object

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



15856
15857
15858
 
# File 'lib/models/porcelain.rb', line 15856

def key_type
  @key_type
end

#lock_required ⇒ Object

When set, require a resource lock to access the resource to ensure it can only be used by one user at a time.



15858
15859
15860
 
# File 'lib/models/porcelain.rb', line 15858

def lock_required
  @lock_required
end

#name ⇒ Object

Unique human-readable name of the Resource.



15860
15861
15862
 
# File 'lib/models/porcelain.rb', line 15860

def name
  @name
end

#port ⇒ Object

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



15862
15863
15864
 
# File 'lib/models/porcelain.rb', line 15862

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



15864
15865
15866
 
# File 'lib/models/porcelain.rb', line 15864

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.



15866
15867
15868
 
# File 'lib/models/porcelain.rb', line 15866

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



15868
15869
15870
 
# File 'lib/models/porcelain.rb', line 15868

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.



15870
15871
15872
 
# File 'lib/models/porcelain.rb', line 15870

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



15872
15873
15874
 
# File 'lib/models/porcelain.rb', line 15872

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.



15874
15875
15876
 
# File 'lib/models/porcelain.rb', line 15874

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



15876
15877
15878
 
# File 'lib/models/porcelain.rb', line 15876

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



15878
15879
15880
 
# File 'lib/models/porcelain.rb', line 15878

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



15920
15921
15922
15923
15924
15925
15926
 
# File 'lib/models/porcelain.rb', line 15920

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