Class: SDM::SQLServerKerberosAD

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_interface: nil, database: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, keytab: nil, krb_config: nil, name: nil, override_database: nil, port: nil, port_override: nil, realm: nil, schema: nil, secret_store_id: nil, server_spn: nil, subdomain: nil, tags: nil, username: nil) ⇒ SQLServerKerberosAD

Returns a new instance of SQLServerKerberosAD.



7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
# File 'lib/models/porcelain.rb', line 7754

def initialize(
  bind_interface: nil,
  database: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  keytab: nil,
  krb_config: nil,
  name: nil,
  override_database: nil,
  port: nil,
  port_override: nil,
  realm: nil,
  schema: nil,
  secret_store_id: nil,
  server_spn: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @database = database == nil ? "" : database
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @keytab = keytab == nil ? "" : keytab
  @krb_config = krb_config == nil ? "" : krb_config
  @name = name == nil ? "" : name
  @override_database = override_database == nil ? false : override_database
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @realm = realm == nil ? "" : realm
  @schema = schema == nil ? "" : schema
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @server_spn = server_spn == nil ? "" : server_spn
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#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.



7716
7717
7718
# File 'lib/models/porcelain.rb', line 7716

def bind_interface
  @bind_interface
end

#databaseObject

The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.



7718
7719
7720
# File 'lib/models/porcelain.rb', line 7718

def database
  @database
end

#egress_filterObject

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



7720
7721
7722
# File 'lib/models/porcelain.rb', line 7720

def egress_filter
  @egress_filter
end

#healthyObject

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



7722
7723
7724
# File 'lib/models/porcelain.rb', line 7722

def healthy
  @healthy
end

#hostnameObject

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



7724
7725
7726
# File 'lib/models/porcelain.rb', line 7724

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



7726
7727
7728
# File 'lib/models/porcelain.rb', line 7726

def id
  @id
end

#keytabObject

The keytab file in base64 format containing an entry with the principal name (username@realm) and key version number with which to authenticate.



7728
7729
7730
# File 'lib/models/porcelain.rb', line 7728

def keytab
  @keytab
end

#krb_configObject

The Kerberos 5 configuration file (krb5.conf) specifying the Active Directory server (KDC) for the configured realm.



7730
7731
7732
# File 'lib/models/porcelain.rb', line 7730

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



7732
7733
7734
# File 'lib/models/porcelain.rb', line 7732

def name
  @name
end

#override_databaseObject

If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.



7734
7735
7736
# File 'lib/models/porcelain.rb', line 7734

def override_database
  @override_database
end

#portObject

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



7736
7737
7738
# File 'lib/models/porcelain.rb', line 7736

def port
  @port
end

#port_overrideObject

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



7738
7739
7740
# File 'lib/models/porcelain.rb', line 7738

def port_override
  @port_override
end

#realmObject

The Active Directory domain (realm) to which the configured username belongs.



7740
7741
7742
# File 'lib/models/porcelain.rb', line 7740

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



7742
7743
7744
# File 'lib/models/porcelain.rb', line 7742

def schema
  @schema
end

#secret_store_idObject

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



7744
7745
7746
# File 'lib/models/porcelain.rb', line 7744

def secret_store_id
  @secret_store_id
end

#server_spnObject

The Service Principal Name of the Microsoft SQL Server instance in Active Directory.



7746
7747
7748
# File 'lib/models/porcelain.rb', line 7746

def server_spn
  @server_spn
end

#subdomainObject

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



7748
7749
7750
# File 'lib/models/porcelain.rb', line 7748

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



7750
7751
7752
# File 'lib/models/porcelain.rb', line 7750

def tags
  @tags
end

#usernameObject

The username to authenticate with.



7752
7753
7754
# File 'lib/models/porcelain.rb', line 7752

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



7796
7797
7798
7799
7800
7801
7802
# File 'lib/models/porcelain.rb', line 7796

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