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(allow_deprecated_encryption: nil, 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.



9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
# File 'lib/models/porcelain.rb', line 9505

def initialize(
  allow_deprecated_encryption: nil,
  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
)
  @allow_deprecated_encryption = allow_deprecated_encryption == nil ? false : allow_deprecated_encryption
  @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

#allow_deprecated_encryptionObject

Whether to allow deprecated encryption protocols to be used for this resource. For example, TLS 1.0.



9465
9466
9467
# File 'lib/models/porcelain.rb', line 9465

def allow_deprecated_encryption
  @allow_deprecated_encryption
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.



9467
9468
9469
# File 'lib/models/porcelain.rb', line 9467

def bind_interface
  @bind_interface
end

#databaseObject

The database for healthchecks, and used for clients if Override Default Database is true.



9469
9470
9471
# File 'lib/models/porcelain.rb', line 9469

def database
  @database
end

#egress_filterObject

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



9471
9472
9473
# File 'lib/models/porcelain.rb', line 9471

def egress_filter
  @egress_filter
end

#healthyObject

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



9473
9474
9475
# File 'lib/models/porcelain.rb', line 9473

def healthy
  @healthy
end

#hostnameObject

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



9475
9476
9477
# File 'lib/models/porcelain.rb', line 9475

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



9477
9478
9479
# File 'lib/models/porcelain.rb', line 9477

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.



9479
9480
9481
# File 'lib/models/porcelain.rb', line 9479

def keytab
  @keytab
end

#krb_configObject

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



9481
9482
9483
# File 'lib/models/porcelain.rb', line 9481

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



9483
9484
9485
# File 'lib/models/porcelain.rb', line 9483

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.



9485
9486
9487
# File 'lib/models/porcelain.rb', line 9485

def override_database
  @override_database
end

#portObject

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



9487
9488
9489
# File 'lib/models/porcelain.rb', line 9487

def port
  @port
end

#port_overrideObject

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



9489
9490
9491
# File 'lib/models/porcelain.rb', line 9489

def port_override
  @port_override
end

#realmObject

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



9491
9492
9493
# File 'lib/models/porcelain.rb', line 9491

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



9493
9494
9495
# File 'lib/models/porcelain.rb', line 9493

def schema
  @schema
end

#secret_store_idObject

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



9495
9496
9497
# File 'lib/models/porcelain.rb', line 9495

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



9497
9498
9499
# File 'lib/models/porcelain.rb', line 9497

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)



9499
9500
9501
# File 'lib/models/porcelain.rb', line 9499

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



9501
9502
9503
# File 'lib/models/porcelain.rb', line 9501

def tags
  @tags
end

#usernameObject

The username to authenticate with.



9503
9504
9505
# File 'lib/models/porcelain.rb', line 9503

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9549
9550
9551
9552
9553
9554
9555
# File 'lib/models/porcelain.rb', line 9549

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