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, lock_required: 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.



16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
 
# File 'lib/models/porcelain.rb', line 16619

def initialize(
  allow_deprecated_key_exchanges: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  key_type: nil,
  lock_required: 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
  @lock_required = lock_required == nil ? false : lock_required
  @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.



16583
16584
16585
 
# File 'lib/models/porcelain.rb', line 16583

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.



16585
16586
16587
 
# File 'lib/models/porcelain.rb', line 16585

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



16587
16588
16589
 
# File 'lib/models/porcelain.rb', line 16587

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



16589
16590
16591
 
# File 'lib/models/porcelain.rb', line 16589

def healthy
  @healthy
end

#hostname ⇒ Object

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



16591
16592
16593
 
# File 'lib/models/porcelain.rb', line 16591

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



16593
16594
16595
 
# File 'lib/models/porcelain.rb', line 16593

def id
  @id
end

#key_type ⇒ Object

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



16595
16596
16597
 
# File 'lib/models/porcelain.rb', line 16595

def key_type
  @key_type
end

#lock_required ⇒ Object

When set, require a resource lock to access the resource to ensure it can only be used by one user at a time.



16597
16598
16599
 
# File 'lib/models/porcelain.rb', line 16597

def lock_required
  @lock_required
end

#name ⇒ Object

Unique human-readable name of the Resource.



16599
16600
16601
 
# File 'lib/models/porcelain.rb', line 16599

def name
  @name
end

#port ⇒ Object

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



16601
16602
16603
 
# File 'lib/models/porcelain.rb', line 16601

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



16603
16604
16605
 
# File 'lib/models/porcelain.rb', line 16603

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.



16605
16606
16607
 
# File 'lib/models/porcelain.rb', line 16605

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



16607
16608
16609
 
# File 'lib/models/porcelain.rb', line 16607

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.



16609
16610
16611
 
# File 'lib/models/porcelain.rb', line 16609

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



16611
16612
16613
 
# File 'lib/models/porcelain.rb', line 16611

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.



16613
16614
16615
 
# File 'lib/models/porcelain.rb', line 16613

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



16615
16616
16617
 
# File 'lib/models/porcelain.rb', line 16615

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



16617
16618
16619
 
# File 'lib/models/porcelain.rb', line 16617

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



16659
16660
16661
16662
16663
16664
16665
 
# File 'lib/models/porcelain.rb', line 16659

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