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.



9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
 
# File 'lib/models/porcelain.rb', line 9995

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.



9963
9964
9965
 
# File 'lib/models/porcelain.rb', line 9963

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.



9965
9966
9967
 
# File 'lib/models/porcelain.rb', line 9965

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



9967
9968
9969
 
# File 'lib/models/porcelain.rb', line 9967

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



9969
9970
9971
 
# File 'lib/models/porcelain.rb', line 9969

def healthy
  @healthy
end

#hostname ⇒ Object

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



9971
9972
9973
 
# File 'lib/models/porcelain.rb', line 9971

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



9973
9974
9975
 
# File 'lib/models/porcelain.rb', line 9973

def id
  @id
end

#key_type ⇒ Object

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



9975
9976
9977
 
# File 'lib/models/porcelain.rb', line 9975

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



9977
9978
9979
 
# File 'lib/models/porcelain.rb', line 9977

def name
  @name
end

#port ⇒ Object

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



9979
9980
9981
 
# File 'lib/models/porcelain.rb', line 9979

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



9981
9982
9983
 
# File 'lib/models/porcelain.rb', line 9981

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



9983
9984
9985
 
# File 'lib/models/porcelain.rb', line 9983

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.



9985
9986
9987
 
# File 'lib/models/porcelain.rb', line 9985

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



9987
9988
9989
 
# File 'lib/models/porcelain.rb', line 9987

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)



9989
9990
9991
 
# File 'lib/models/porcelain.rb', line 9989

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



9991
9992
9993
 
# File 'lib/models/porcelain.rb', line 9991

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



9993
9994
9995
 
# File 'lib/models/porcelain.rb', line 9993

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10031
10032
10033
10034
10035
10036
10037
 
# File 'lib/models/porcelain.rb', line 10031

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