API::Plesk::Accounts - extension module for the management of user accounts.


API-Plesk documentation  | view source Contained in the API-Plesk distribution.

Index


NAME

Top

API::Plesk::Accounts - extension module for the management of user accounts.

SYNOPSIS

Top

Directly not used, calls via API::Plesk.

 use API::Plesk;

 my $plesk_client = API::Plesk->new(%params);
 # See documentations for API::Plesk

 my $res1 = $plesk_client->Accounts->get(
    id => 36341
 );




DESCRIPTION

Top

The module provides full support operations with accounts.

EXPORT

Top

None by default.

METHODS

Top

create(%params)

Creates a user account on the basis of the template.

Params: general_info -- hashref with user data template-name or template-id

Return: response object with created account id in data filed.

modify(%params)

Changes the parameters account.

Params: limits, permissions, new_data -- hashref`s with corresponding blocks.

And also one of the following options:

  all   => 1      - for all accounts.
  login => 'name' - for a given login.
  id    => 123    - for a given id 

delete(%params)

Delete accounts.

Params: limits, permissions, new_data -- hashref`s with corresponding blocks.

And also one of the following options:

  all   => 1      - all accounts.
  login => 'name' - account with a given login.
  id    => 123    - account with a given id 

get(%params)

Get account details from Plesk.

Params:

One of the following options:

  all   => 1      - for all accounts.
  login => 'name' - for account with a given login.
  id    => 123    - for account with a given id 

AUTHOR

Top

Odintsov Pavel <nrg[at]cpan.org> Nikolay Shulyakovskiy <shulyakovskiy[at]rambler.ru>

COPYRIGHT AND LICENSE

Top


API-Plesk documentation  | view source Contained in the API-Plesk distribution.