Gateway Administration Guide - Platform - BlueCat Gateway - 24.3

Locale: English
Product name: BlueCat Gateway
Version: 24.3

Preface
Audience
Release Support Policy
What is BlueCat Gateway?
Key Features
What's New in BlueCat Gateway v24.3
Changes in behavior
BlueCat Gateway architecture
BlueCat Gateway glossary
Installing and upgrading Gateway
Upgrading BlueCat Gateway
Configuring Apache Virtual Hosts
Global Apache configuration file
HTTP and HTTPS Apache configuration files
Best practices for custom Apache configuration files
Setting the Address Manager REST API client version
Setting up custom SSL certificates for HTTPS connections
Setting up Micetro URLs in the config.json file.
Installing Gateway instances behind a load balancer
Using BlueCat Gateway
About BlueCat Gateway workflows
Configuring BlueCat Gateway
General configuration
Configuring BAM/Micetro settings
Configuring Interface settings
Configuring Certificates settings
Configuring Logs settings
Configuring Customization settings
Configuring Security settings
Configuring Content security policy headers
Configuring Cross-origin resource sharing (CORS)
Configuring transport security response headers
Configuring caching policies
Mail configuration
MongoDB configuration
Encrypt Password page
Setting the Address Manager REST API client version
Managing Gateway users and permissions
Configuring Gateway user groups
Setting page and REST endpoint permissions
Single Sign-On and OAuth
Requirements for configuring Single Sign-On and OAuth
Configuring Single Sign-On
Configuring SSO SAML settings
Creating JSON SSO configuration setting files
Configuring SSO OAuth settings
Enabling Gateway SSO
Single Sign-On (SSO) and OAuth Troubleshooting
How the Gateway Single Sign-On process works
How OAuth API authorization works
Configuring Cross-Jump authentication for Address Manager and Gateway
High availability and Gateway Availability groups
Gateway High Availability requirements and limitations
How Availability groups work
Setting up an Availability group
Managing Availability groups
Using Gateway Availability groups in custom workflows
High availability configuration settings
Logging events and monitoring BlueCat Gateway status
Gateway Logging
Viewing logs from Gateway
Setting up custom logs for Gateway
Downloading BlueCat Gateway log files
Apache server logs
Adding to user session logs from custom workflows
Log rotation in Gateway
User login and logout records
Log settings configuration file
Gateway warnings and exceptions
Managing Gateway workflows
Administrative workflows
About Gateway workflow endpoints
Workflow management
Manually importing and exporting workflows
Importing workflows manually
Importing and exporting workflows in the Gateway UI
Exporting workflows via the BlueCat Gateway user interface
Importing workflows from Git repositories
Importing workflows from a GitHub repository
Importing workflows from a private GitLab repository
Importing workflows from the BlueCat GitHub Community Folder
Re-installing workflows
Creating and reverting to workflow snapshots
Adding Built-in workflows to the BlueCat Gateway Container
Developing custom BlueCat Gateway workflows
About workspaces
Built-in Workspace
About Gateway workflow endpoints
Setting up a new Custom Workflow
Next steps in creating a UI workflow
Editing a workflow script
Customizing the color palette
Creating workflows with UI Component Fields
UI Component Field events
UI Component Fields
Support in future releases
Python modules
Manually importing and exporting workflows
Setting up Gateway Autologin module scripts
Workflow development best practices and limitations
Saving Workflow State/Configuration
Using custom HTML templates
Referencing code inside BlueCat Gateway
Using Python modules shipped with BlueCat Gateway
Importing and exporting CSV files in DataTables
Handling workflow exceptions
Customizing the color palette
UI Component Fields
Support in future releases
Python modules
Deploying BlueCat Gateway into a production environment
Update your ServerAdmin and ServerName settings
Provide custom TLS/SSL certificates to Gateway
Configure Gateway log locations
Enable HTTPS on Gateway and Address Manager
Configure the Production URL for BlueCat Address Manager
Configure timeouts for the production environment
Set the secret key for the production environment
Generate custom image for production
BlueCat Python Web Framework
Authentication
REST API usage
Permissions
Pluggable pages and workflows
Developing workflows using the Address Manager RESTful v2 API
Workflow development quickstart
Available Python APIs
Using the Address Manager REST v2 API client
Building workflows that work with both REST v1 and REST v2
Using the legacy Address Manager REST v1 API client
Gateway APIs: Advanced topics
Troubleshooting REST API version settings
Migrating from REST v1 to REST v2
Developing workflows using the Micetro REST API client
Micetro REST API error handling
Example Micetro Authentication workflow
Running a Gateway workflow using the Micetro REST API client
HTTP API references
Gateway status HTTP API
Import workflows HTTP API
Availability group HTTP API
GET /ag/api/v1/state
GET /ag/api/v1/group
PUT /ag/api/v1/configuration
POST /ag/api/v1/group
DELETE /ag/api/v1/group
PUT /ag/api/v1/group
PUT /ag/api/v1/group/members
DELETE /ag/api/v1/group/members
PUT /ag/api/v1/failover
Address Manager REST v2 API client reference
Client class
BAMV2ErrorResponse class
MediaType class
Micetro REST API client reference
Client class
MicetroV2ErrorResponse class
MediaType class
ResponseMessage class
Python API references
BlueCat Library API
Address Manager REST v1 API reference
Address Manager Client class API reference
Client class
BlueCat Python REST v1 API exceptions
GeneralError exception
ClientError exception
ErrorResponse exception
UnexpectedResponse exception
BlueCat Python REST v1 API library data models
models module
BlueCat Python REST v1 API values and constants
AccessRightValues class
AdditionalIPServiceType class
DefinedProbe class
DefinedProbeStatus class
DeploymentTaskStatus class
DHCP6ClientDeploymentOptionType class
DHCPCustomOptionType class
DHCPDefineRange class
DHCPDeploymentRoleType class
DHCPMatchClass class
DHCPServiceOption class
DHCPServiceOptionConstant class
DiscoveryType class
DNSDeploymentRoleType class
EnumServices class
IPAddressState class
IPAssignmentActionValues class
IPGroupRangePosition class
ObjectType class
OptionType class
parse_version function
ResponsePolicy class
ServerCapabilityProfiles class
ServersDeploymentStatus class
SNMPVersion class
TraversalMethod class
UserDefinedFieldType class
UserDefinedLinkEntityType class
VendorProfileOptionType class
Version class
ZoneTemplateReapplyMode class
Address Manager Failover Client
Failover API client
BlueCat Edge Python API reference
Clients
Edge client
Service Point API client
Exceptions
GeneralError exception
ClientError exception
ErrorResponse exception
UnexpectedResponse exception
EdgeErrorResponse exception
Values
ErrorResponseCode class
Internal client
Instance class
Gateway Python APIs
Address Manager REST v1 API client reference
Address Manager REST v1 API classes
AccessRight class
AliasRecord class
API class
APIObject class
Configuration class
DHCPRawOption class
DHCPV6RawOption class
DNSRawOption class
DNSDeploymentOption class
DNSDeploymentRole class
DHCPDeploymentRole class
Entity class
ExternalHostRecord class
GenericRecord class
HostInfoRecord class
HostRecord class
IP4Address class
IP4Block class
IP4BlockNetwork class
IP4Network class
IP6Address class
IP6Block class
IP6BlockNetwork class
IP6Network class
IPAddress class
IPObject class
MACAddress class
MXRecord class
NAPTRRecord class
ResourceRecord class
ResponsePolicy class
ResponsePolicyItem class
Server class
SRVRecord class
Tag class
TagGroup class
TextRecord class
TFTPGroup class
TFTPDeploymentRole class
TFTPFolder class
TSIGKey class
User class
UserGroup class
View class
Zone class
AliasRecord class for backward-compatibility
Address Manager REST v1 API Modules
constants module
nsupdate module
About the BAMAPI class (Address Manager REST v1 and v2)
BAMAPI class
Gateway platform API reference
Platform class
Address Manager UserSession class
Micetro UserSession class
api_exception module
platform_version function
require_user function
server_endpoints module
util module
wtform_extensions module
wtform_fields module
About the MicetroAPI class
MicetroAPI class
Availability group API reference
EventId class
get_node_state function
HeartbeatMethod class
NodeDnsConnectionState class
NodeRole class
NodeRoleChanged class
NodeState class
subscribe function

Back to home page