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.



14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
 
# File 'lib/models/porcelain.rb', line 14984

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.



14950
14951
14952
 
# File 'lib/models/porcelain.rb', line 14950

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.



14952
14953
14954
 
# File 'lib/models/porcelain.rb', line 14952

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



14954
14955
14956
 
# File 'lib/models/porcelain.rb', line 14954

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



14956
14957
14958
 
# File 'lib/models/porcelain.rb', line 14956

def healthy
  @healthy
end

#hostname ⇒ Object

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



14958
14959
14960
 
# File 'lib/models/porcelain.rb', line 14958

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



14960
14961
14962
 
# File 'lib/models/porcelain.rb', line 14960

def id
  @id
end

#key_type ⇒ Object

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



14962
14963
14964
 
# File 'lib/models/porcelain.rb', line 14962

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



14964
14965
14966
 
# File 'lib/models/porcelain.rb', line 14964

def name
  @name
end

#port ⇒ Object

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



14966
14967
14968
 
# File 'lib/models/porcelain.rb', line 14966

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



14968
14969
14970
 
# File 'lib/models/porcelain.rb', line 14968

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.



14970
14971
14972
 
# File 'lib/models/porcelain.rb', line 14970

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



14972
14973
14974
 
# File 'lib/models/porcelain.rb', line 14972

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.



14974
14975
14976
 
# File 'lib/models/porcelain.rb', line 14974

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



14976
14977
14978
 
# File 'lib/models/porcelain.rb', line 14976

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.



14978
14979
14980
 
# File 'lib/models/porcelain.rb', line 14978

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14980
14981
14982
 
# File 'lib/models/porcelain.rb', line 14980

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



14982
14983
14984
 
# File 'lib/models/porcelain.rb', line 14982

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



15022
15023
15024
15025
15026
15027
15028
 
# File 'lib/models/porcelain.rb', line 15022

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