module Octokit::EnterpriseManagementConsoleClient::ManagementConsole

Methods for the Enterprise Management Console API

@see developer.github.com/v3/enterprise-admin/management_console/

Public Instance Methods

add_authorized_key(key) click to toggle source

Add an authorized SSH keys on the Enterprise install

@param key Either the file path to a key, a File handler to the key, or the contents of the key itself @return [Sawyer::Resource] An array of authorized SSH keys

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 106
def add_authorized_key(key)
  queries = password_hash
  case key
  when String
    if File.exist?(key)
      key = File.open(key, "r")
      content = key.read.strip
      key.close
    else
      content = key
    end
  when File
    content = key.read.strip
    key.close
  end

  queries[:query][:authorized_key] = content
  post "/setup/api/settings/authorized-keys", queries
end
authorized_keys() click to toggle source

Fetch the authorized SSH keys on the Enterprise install

@return [Sawyer::Resource] An array of authorized SSH keys

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 97
def authorized_keys
  get "/setup/api/settings/authorized-keys", password_hash
end
Also aliased as: get_authorized_keys
config_check()
Alias for: config_status
config_status() click to toggle source

Get information about the Enterprise installation

@return [Sawyer::Resource] The installation information

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 51
def config_status
  get "/setup/api/configcheck", password_hash
end
Also aliased as: config_check
delete_authorized_key(key)
edit_maintenance_status(maintenance)
edit_settings(settings) click to toggle source

Modify the Enterprise settings

@param settings [Hash] A hash configuration of the new settings

@return [nil]

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 69
def edit_settings(settings)
  queries = password_hash
  queries[:query][:settings] = "#{settings.to_json}"
  put "/setup/api/settings", queries
end
get_authorized_keys()
Alias for: authorized_keys
get_maintenance_status()
Alias for: maintenance_status
get_settings()
Alias for: settings
maintenance_status() click to toggle source

Get information about the Enterprise maintenance status

@return [Sawyer::Resource] The maintenance status

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 78
def maintenance_status
  get "/setup/api/maintenance", password_hash
end
Also aliased as: get_maintenance_status
remove_authorized_key(key) click to toggle source

Removes an authorized SSH keys from the Enterprise install

@param key Either the file path to a key, a File handler to the key, or the contents of the key itself @return [Sawyer::Resource] An array of authorized SSH keys

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 130
def remove_authorized_key(key)
  queries = password_hash
  case key
  when String
    if File.exist?(key)
      key = File.open(key, "r")
      content = key.read.strip
      key.close
    else
      content = key
    end
  when File
    content = key.read.strip
    key.close
  end

  queries[:query][:authorized_key] = content
  delete "/setup/api/settings/authorized-keys", queries
end
Also aliased as: delete_authorized_key
set_maintenance_status(maintenance) click to toggle source

Start (or turn off) the Enterprise maintenance mode

@param maintenance [Hash] A hash configuration of the maintenance settings @return [nil]

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 87
def set_maintenance_status(maintenance)
  queries = password_hash
  queries[:query][:maintenance] = "#{maintenance.to_json}"
  post "/setup/api/maintenance", queries
end
Also aliased as: edit_maintenance_status
settings() click to toggle source

Get information about the Enterprise installation

@return [Sawyer::Resource] The settings

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 59
def settings
  get "/setup/api/settings", password_hash
end
Also aliased as: get_settings
start_configuration() click to toggle source

Start a configuration process.

@return nil

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 30
def start_configuration
  post "/setup/api/configure", password_hash
end
upgrade(license) click to toggle source

Upgrade an Enterprise installation

@param license [String] The path to your .ghl license file.

@return nil

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 39
def upgrade(license)
  conn = faraday_configuration

  params = { }
  params[:license] = Faraday::UploadIO.new(license, 'binary')
  params[:api_key] = @management_console_password
  @last_response = conn.post("/setup/api/upgrade", params)
end
upload_license(license, settings = nil) click to toggle source

Uploads a license for the first time

@param license [String] The path to your .ghl license file. @param settings [Hash] A hash configuration of the initial settings.

@see http: //git.io/j5NT @return nil

# File lib/octokit/enterprise_management_console_client/management_console.rb, line 16
def upload_license(license, settings = nil)
  conn = faraday_configuration

  params = { }
  params[:license] = Faraday::UploadIO.new(license, 'binary')
  params[:password] = @management_console_password
  params[:settings] = "#{settings.to_json}" unless settings.nil?

  @last_response = conn.post("/setup/api/start", params)
end