startup.md

Startup

startup_controller = client.startup

Class Name

StartupController

Methods

• Complete Wizard
• Get First User
• Get First User 2
• Get Startup Configuration
• Set Remote Access
• Update Initial Configuration
• Update Startup User

Complete Wizard

Completes the startup wizard.

def complete_wizard(self)

Response Type

void

Example Usage

result = startup_controller.complete_wizard()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get First User

Gets the first user.

def get_first_user(self)

Response Type

StartupUserDto

Example Usage

result = startup_controller.get_first_user()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get First User 2

Gets the first user.

def get_first_user_2(self)

Response Type

StartupUserDto

Example Usage

result = startup_controller.get_first_user_2()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Startup Configuration

Gets the initial startup wizard configuration.

def get_startup_configuration(self)

Response Type

StartupConfigurationDto

Example Usage

result = startup_controller.get_startup_configuration()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Set Remote Access

Sets remote access and UPnP.

def set_remote_access(self,
                     body)

Parameters

Parameter	Type	Tags	Description
body	StartupRemoteAccessDto	Body, Required	The startup remote access dto.

Response Type

void

Example Usage

body = StartupRemoteAccessDto()
body.enable_remote_access = False
body.enable_automatic_port_mapping = False

result = startup_controller.set_remote_access(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Update Initial Configuration

Sets the initial startup wizard configuration.

def update_initial_configuration(self,
                                body)

Parameters

Parameter	Type	Tags	Description
body	StartupConfigurationDto	Body, Required	The updated startup configuration.

Response Type

void

Example Usage

body = StartupConfigurationDto()

result = startup_controller.update_initial_configuration(body)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Update Startup User

Sets the user name and password.

def update_startup_user(self,
                       body=None)

Parameters

Parameter	Type	Tags	Description
body	StartupUserDto	Body, Optional	The DTO containing username and password.

Response Type

void

Example Usage

result = startup_controller.update_startup_user()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException