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.



10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
 
# File 'lib/models/porcelain.rb', line 10067

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.



10035
10036
10037
 
# File 'lib/models/porcelain.rb', line 10035

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.



10037
10038
10039
 
# File 'lib/models/porcelain.rb', line 10037

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



10039
10040
10041
 
# File 'lib/models/porcelain.rb', line 10039

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



10041
10042
10043
 
# File 'lib/models/porcelain.rb', line 10041

def healthy
  @healthy
end

#hostname ⇒ Object

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



10043
10044
10045
 
# File 'lib/models/porcelain.rb', line 10043

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



10045
10046
10047
 
# File 'lib/models/porcelain.rb', line 10045

def id
  @id
end

#key_type ⇒ Object

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



10047
10048
10049
 
# File 'lib/models/porcelain.rb', line 10047

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



10049
10050
10051
 
# File 'lib/models/porcelain.rb', line 10049

def name
  @name
end

#port ⇒ Object

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



10051
10052
10053
 
# File 'lib/models/porcelain.rb', line 10051

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



10053
10054
10055
 
# File 'lib/models/porcelain.rb', line 10053

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



10055
10056
10057
 
# File 'lib/models/porcelain.rb', line 10055

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.



10057
10058
10059
 
# File 'lib/models/porcelain.rb', line 10057

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



10059
10060
10061
 
# File 'lib/models/porcelain.rb', line 10059

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)



10061
10062
10063
 
# File 'lib/models/porcelain.rb', line 10061

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



10063
10064
10065
 
# File 'lib/models/porcelain.rb', line 10063

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



10065
10066
10067
 
# File 'lib/models/porcelain.rb', line 10065

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10103
10104
10105
10106
10107
10108
10109
 
# File 'lib/models/porcelain.rb', line 10103

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