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.



8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
# File 'lib/models/porcelain.rb', line 8344

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.



8306
8307
8308
# File 'lib/models/porcelain.rb', line 8306

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.



8308
8309
8310
# File 'lib/models/porcelain.rb', line 8308

def database
  @database
end

#egress_filterObject

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



8310
8311
8312
# File 'lib/models/porcelain.rb', line 8310

def egress_filter
  @egress_filter
end

#healthyObject

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



8312
8313
8314
# File 'lib/models/porcelain.rb', line 8312

def healthy
  @healthy
end

#hostnameObject

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



8314
8315
8316
# File 'lib/models/porcelain.rb', line 8314

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8316
8317
8318
# File 'lib/models/porcelain.rb', line 8316

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.



8318
8319
8320
# File 'lib/models/porcelain.rb', line 8318

def keytab
  @keytab
end

#krb_configObject

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



8320
8321
8322
# File 'lib/models/porcelain.rb', line 8320

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



8322
8323
8324
# File 'lib/models/porcelain.rb', line 8322

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.



8324
8325
8326
# File 'lib/models/porcelain.rb', line 8324

def override_database
  @override_database
end

#portObject

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



8326
8327
8328
# File 'lib/models/porcelain.rb', line 8326

def port
  @port
end

#port_overrideObject

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



8328
8329
8330
# File 'lib/models/porcelain.rb', line 8328

def port_override
  @port_override
end

#realmObject

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



8330
8331
8332
# File 'lib/models/porcelain.rb', line 8330

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



8332
8333
8334
# File 'lib/models/porcelain.rb', line 8332

def schema
  @schema
end

#secret_store_idObject

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



8334
8335
8336
# File 'lib/models/porcelain.rb', line 8334

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



8336
8337
8338
# File 'lib/models/porcelain.rb', line 8336

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)



8338
8339
8340
# File 'lib/models/porcelain.rb', line 8338

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8340
8341
8342
# File 'lib/models/porcelain.rb', line 8340

def tags
  @tags
end

#usernameObject

The username to authenticate with.



8342
8343
8344
# File 'lib/models/porcelain.rb', line 8342

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8386
8387
8388
8389
8390
8391
8392
# File 'lib/models/porcelain.rb', line 8386

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