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.



13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
 
# File 'lib/models/porcelain.rb', line 13683

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.



13649
13650
13651
 
# File 'lib/models/porcelain.rb', line 13649

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.



13651
13652
13653
 
# File 'lib/models/porcelain.rb', line 13651

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



13653
13654
13655
 
# File 'lib/models/porcelain.rb', line 13653

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



13655
13656
13657
 
# File 'lib/models/porcelain.rb', line 13655

def healthy
  @healthy
end

#hostname ⇒ Object

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



13657
13658
13659
 
# File 'lib/models/porcelain.rb', line 13657

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



13659
13660
13661
 
# File 'lib/models/porcelain.rb', line 13659

def id
  @id
end

#key_type ⇒ Object

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



13661
13662
13663
 
# File 'lib/models/porcelain.rb', line 13661

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



13663
13664
13665
 
# File 'lib/models/porcelain.rb', line 13663

def name
  @name
end

#port ⇒ Object

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



13665
13666
13667
 
# File 'lib/models/porcelain.rb', line 13665

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



13667
13668
13669
 
# File 'lib/models/porcelain.rb', line 13667

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.



13669
13670
13671
 
# File 'lib/models/porcelain.rb', line 13669

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



13671
13672
13673
 
# File 'lib/models/porcelain.rb', line 13671

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.



13673
13674
13675
 
# File 'lib/models/porcelain.rb', line 13673

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



13675
13676
13677
 
# File 'lib/models/porcelain.rb', line 13675

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.



13677
13678
13679
 
# File 'lib/models/porcelain.rb', line 13677

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13679
13680
13681
 
# File 'lib/models/porcelain.rb', line 13679

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



13681
13682
13683
 
# File 'lib/models/porcelain.rb', line 13681

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13721
13722
13723
13724
13725
13726
13727
 
# File 'lib/models/porcelain.rb', line 13721

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