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.



9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
 
# File 'lib/models/porcelain.rb', line 9913

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.



9881
9882
9883
 
# File 'lib/models/porcelain.rb', line 9881

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.



9883
9884
9885
 
# File 'lib/models/porcelain.rb', line 9883

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



9885
9886
9887
 
# File 'lib/models/porcelain.rb', line 9885

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



9887
9888
9889
 
# File 'lib/models/porcelain.rb', line 9887

def healthy
  @healthy
end

#hostname ⇒ Object

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



9889
9890
9891
 
# File 'lib/models/porcelain.rb', line 9889

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



9891
9892
9893
 
# File 'lib/models/porcelain.rb', line 9891

def id
  @id
end

#key_type ⇒ Object

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



9893
9894
9895
 
# File 'lib/models/porcelain.rb', line 9893

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



9895
9896
9897
 
# File 'lib/models/porcelain.rb', line 9895

def name
  @name
end

#port ⇒ Object

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



9897
9898
9899
 
# File 'lib/models/porcelain.rb', line 9897

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



9899
9900
9901
 
# File 'lib/models/porcelain.rb', line 9899

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



9901
9902
9903
 
# File 'lib/models/porcelain.rb', line 9901

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.



9903
9904
9905
 
# File 'lib/models/porcelain.rb', line 9903

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



9905
9906
9907
 
# File 'lib/models/porcelain.rb', line 9905

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)



9907
9908
9909
 
# File 'lib/models/porcelain.rb', line 9907

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



9909
9910
9911
 
# File 'lib/models/porcelain.rb', line 9909

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



9911
9912
9913
 
# File 'lib/models/porcelain.rb', line 9911

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9949
9950
9951
9952
9953
9954
9955
 
# File 'lib/models/porcelain.rb', line 9949

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