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



8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
# File 'lib/models/porcelain.rb', line 8996

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_exchangesObject

Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.



8964
8965
8966
# File 'lib/models/porcelain.rb', line 8964

def allow_deprecated_key_exchanges
  @allow_deprecated_key_exchanges
end

#bind_interfaceObject

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.



8966
8967
8968
# File 'lib/models/porcelain.rb', line 8966

def bind_interface
  @bind_interface
end

#egress_filterObject

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



8968
8969
8970
# File 'lib/models/porcelain.rb', line 8968

def egress_filter
  @egress_filter
end

#healthyObject

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



8970
8971
8972
# File 'lib/models/porcelain.rb', line 8970

def healthy
  @healthy
end

#hostnameObject

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



8972
8973
8974
# File 'lib/models/porcelain.rb', line 8972

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8974
8975
8976
# File 'lib/models/porcelain.rb', line 8974

def id
  @id
end

#key_typeObject

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



8976
8977
8978
# File 'lib/models/porcelain.rb', line 8976

def key_type
  @key_type
end

#nameObject

Unique human-readable name of the Resource.



8978
8979
8980
# File 'lib/models/porcelain.rb', line 8978

def name
  @name
end

#portObject

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



8980
8981
8982
# File 'lib/models/porcelain.rb', line 8980

def port
  @port
end

#port_forwardingObject

Whether port forwarding is allowed through this server.



8982
8983
8984
# File 'lib/models/porcelain.rb', line 8982

def port_forwarding
  @port_forwarding
end

#port_overrideObject

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



8984
8985
8986
# File 'lib/models/porcelain.rb', line 8984

def port_override
  @port_override
end

#public_keyObject

The public key to append to a server's authorized keys. This will be generated after resource creation.



8986
8987
8988
# File 'lib/models/porcelain.rb', line 8986

def public_key
  @public_key
end

#secret_store_idObject

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



8988
8989
8990
# File 'lib/models/porcelain.rb', line 8988

def secret_store_id
  @secret_store_id
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



8990
8991
8992
# File 'lib/models/porcelain.rb', line 8990

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8992
8993
8994
# File 'lib/models/porcelain.rb', line 8992

def tags
  @tags
end

#usernameObject

The username to authenticate with.



8994
8995
8996
# File 'lib/models/porcelain.rb', line 8994

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9032
9033
9034
9035
9036
9037
9038
# File 'lib/models/porcelain.rb', line 9032

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