Справочник команд

Утилита командной строки для Yandex 360

usage: ya360 [-h] [-V]
             {whois,user,group,department,mailbox,logs,antispam,routing,make-config}
             ...

Позиционные аргументы

sub_com: Возможные значения: whois, user, group, department, mailbox, logs, antispam, routing, make-config

Опции

-V, --version: show program’s version number and exit

Команды:

whois

Кто это?

ya360 whois [-h] name

Позиционные аргументы

name: nickname, alias или label разыскиваемой сущности

user

Действия над пользователем

ya360 user [-h]
           {create,update,delete,add-alias,delete-alias,show,show-all,avatar}
           ...

Позиционные аргументы

sub_com_user: Возможные значения: create, update, delete, add-alias, delete-alias, show, show-all, avatar

Команды:

create

Создать пользователя

ya360 user create [-h] [--displayName DISPLAYNAME]
                  [--departmentId DEPARTMENTID] [--about ABOUT]
                  [--birthday BIRTHDAY] [--phone PHONE] [--gender GENDER]
                  [--isAdmin {true,false}] [--language LANGUAGE]
                  [--position POSITION] [--timezone TIMEZONE]
                  nickname [name ...] password

Позиционные аргументы

nickname: Login пользователя
name: Фамилия Имя Отчество
password: Пароль

Опции

--displayName

displayName

--departmentId

ID подразделения

Default: 1

--about

Описание пользователя

--birthday

YYYY-MM-DD

--phone

Телефонный номер

--gender

Пол

--isAdmin

Возможные значения: true, false

Признак администратора организации

--language

Язык

--position

Должность

--timezone

Часовой пояс

update

Изменить данные пользователя

ya360 user update [-h] [--displayName DISPLAYNAME] [--name [NAME ...]]
                  [--about ABOUT] [--birthday BIRTHDAY] [--phone PHONE]
                  [--departmentId DEPARTMENTID] [--gender GENDER]
                  [--isAdmin {true,false}] [--isEnabled {true,false}]
                  [--language LANGUAGE] [--password PASSWORD]
                  [--passwordChangeRequired {true,false}]
                  [--position POSITION] [--timezone TIMEZONE]
                  nickname

Позиционные аргументы

nickname: Login пользователя

Опции

--displayName

displayName

--name

Фамилия Имя Отчество

--about

Описание пользователя

--birthday

YYYY-MM-DD

--phone

Телефонный номер

--departmentId

ID подразделения

--gender

Пол

--isAdmin

Возможные значения: true, false

Признак администратора организации

--isEnabled

Возможные значения: true, false

Статус аккаунта

--language

Язык

--password

Пароль

--passwordChangeRequired

Возможные значения: true, false

Обязательность изменения пароля при первом входе

--position

Должность

--timezone

Часовой пояс

delete

Опасно

Данная операция необратима! Удаление пользователя приведет к моментальному удалению всех данных в почте и на диске!

ya360 user delete [-h] nickname

Позиционные аргументы

nickname: Login пользователя

add-alias

Добавить алиас пользователю

ya360 user add-alias [-h] nickname alias

Позиционные аргументы

nickname: Login пользователя
alias: alias

delete-alias

Удалить алиас у пользователя

ya360 user delete-alias [-h] nickname alias

Позиционные аргументы

nickname: Login пользователя
alias: alias

show

Вывести информацию о пользователе

ya360 user show [-h] nickname

Позиционные аргументы

nickname: Login пользователя

show-all

Вывести список пользователей

ya360 user show-all [-h] [--page PAGE] [--perPage PERPAGE] [--csv CSV]

Опции

--page: Номер страницы
--perPage: Количество записей на странице
--csv: Выгрузить в CSV файл

avatar

Загрузить портрет пользователя

ya360 user avatar [-h] nickname filename

Позиционные аргументы

nickname: Login пользователя
filename: Имя файла

group

Действия над группой

ya360 group [-h]
            {create,update,add-member,delete-member,delete,show,show-all} ...

Позиционные аргументы

sub_com_group

Возможные значения: create, update, add-member, delete-member, delete, show, show-all

Действия над группой

Команды:

create

Создать группу

ya360 group create [-h] [--adminIds ADMINIDS] [--description DESCRIPTION]
                   label name

Позиционные аргументы

label: Имя группы
name: Название группы

Опции

--adminIds: Руководители
--description: Описание группы

update

Изменить группу

ya360 group update [-h] [--newlabel NEWLABEL] [--name NAME]
                   [--adminIds ADMINIDS] [--description DESCRIPTION]
                   label

Позиционные аргументы

label: Имя группы

Опции

--newlabel: Новое имя группы
--name: Название группы
--adminIds: Руководители
--description: Описание группы

add-member

Добавить участника в группу

ya360 group add-member [-h] label member

Позиционные аргументы

label: Имя группы
member: Участник (login для пользователя или имя для группы или подразделения)

delete-member

Удалить участника из группы

ya360 group delete-member [-h] label member

Позиционные аргументы

label: Имя группы
member: Участник (login для пользователя или имя для группы или подразделения)

delete

Опасно

Данную операцию невозможно отменить!

Удалить группу

ya360 group delete [-h] label

Позиционные аргументы

label: Имя группы

show

Показать информацию о группе

ya360 group show [-h] label

Позиционные аргументы

label: Имя группы

show-all

Показать список групп

ya360 group show-all [-h] [--page PAGE] [--perPage PERPAGE] [--csv CSV]

Опции

--page: Номер страницы
--perPage: Количество записей на странице
--csv: Выгрузить в CSV файл

department

Действия над подразделением

ya360 department [-h]
                 {create,update,add-alias,delete-alias,delete,show,show-all}
                 ...

Позиционные аргументы

sub_com_department

Возможные значения: create, update, add-alias, delete-alias, delete, show, show-all

Действия над подразделением

Команды:

create

Создать подразделение

ya360 department create [-h] [--parentlabel PARENTLABEL]
                        [--headlabel HEADLABEL] [--description DESCRIPTION]
                        label name

Позиционные аргументы

label: Имя подразделения
name: Название подразделения

Опции

--parentlabel: Имя родительского подразделения
--headlabel: Login руководителя подразделения
--description: Описание подразделения

update

Изменить подразделение

ya360 department update [-h] [--newlabel NEWLABEL] [--parentlabel PARENTLABEL]
                        [--name NAME] [--headnickname HEADNICKNAME]
                        [--description DESCRIPTION]
                        label

Позиционные аргументы

label: Имя подразделения

Опции

--newlabel: Новое имя подразделения
--parentlabel: Имя родительского подразделения
--name: Название подразделения
--headnickname: Login руководителя подразделения
--description: Описание подразделения

add-alias

Добавить алиас подразделению

ya360 department add-alias [-h] label alias

Позиционные аргументы

label: Имя подразделения
alias: alias

delete-alias

Удалить алиас у подразделения

ya360 department delete-alias [-h] label alias

Позиционные аргументы

label: Имя подразделения
alias: alias

delete

Опасно

Данную операцию невозможно отменить!

Удалить подразделение

ya360 department delete [-h] label

Позиционные аргументы

label: Имя подразделения

show

Показать информацию о подразделении

ya360 department show [-h] label

Позиционные аргументы

label: Имя подразделения

show-all

Показать список подразделений

ya360 department show-all [-h] [--page PAGE] [--perPage PERPAGE]
                          [--parentId PARENTID] [--orderBy {id,name}]
                          [--csv CSV]

Опции

--page

Номер страницы

--perPage

Количество записей на странице

--parentId

Идентификатор родителя

--orderBy

Возможные значения: id, name

Сортировать по

--csv

Выгрузить в CSV файл

mailbox

Операции с почтовыми ящиками и отправителями

ya360 mailbox [-h]
              {delegated,delete,status,list-mailboxes,list-users,sender} ...

Позиционные аргументы

sub_com_mailbox: Возможные значения: delegated, delete, status, list-mailboxes, list-users, sender

Команды:

delegated

Делегирование доступа к почтовому ящику

ya360 mailbox delegated [-h] [--imap_full_access] [--send_on_behalf]
                        [--send_as]
                        nickname to_nickname

Позиционные аргументы

nickname: Login пользователя почтового ящика
to_nickname: Login пользователя кому делегируем

Опции

--imap_full_access

право на чтение почты и управление настройками ящика

Default: False

--send_on_behalf

право на отправление писем от своего имени

Default: False

--send_as

право на отправление писем от имени владельца ящика

Default: False

delete

Удалить доступ к почтовому ящику

ya360 mailbox delete [-h] nickname to_nickname

Позиционные аргументы

nickname: Login пользователя почтового ящика
to_nickname: Login пользователя у кого удаляются права

status

Статус выполнения задачи

ya360 mailbox status [-h] taskid

Позиционные аргументы

taskid: Номер задания

list-mailboxes

Список почтовых ящиков, к которым у сотрудника есть права доступа

ya360 mailbox list-mailboxes [-h] nickname

Позиционные аргументы

nickname: Login пользователя

list-users

Список сотрудников, у которых есть права доступа к почтовому ящику

ya360 mailbox list-users [-h] nickname

Позиционные аргументы

nickname: Login пользователя почтового ящика

sender

Управление отправителем

ya360 mailbox sender [-h] {main-address,sign-position,signs} ...

Позиционные аргументы

sub_com_sender_mailbox: Возможные значения: main-address, sign-position, signs

Команды:

main-address

Управление основным адресом

ya360 mailbox sender main-address [-h] {show,edit} ...

Позиционные аргументы

sub_com_main_address: Возможные значения: show, edit

Команды:

show

Отобразить основной адрес

ya360 mailbox sender main-address show [-h] nickname

Позиционные аргументы

nickname: Login пользователя почтового ящика

edit

Изменить основной адрес

ya360 mailbox sender main-address edit [-h] nickname defaultFrom

Позиционные аргументы

nickname: Login пользователя почтового ящика
defaultFrom: Основлной адрес

sign-position

Расположение подписей

ya360 mailbox sender sign-position [-h] nickname {bottom,under}

Позиционные аргументы

nickname

Login пользователя почтового ящика

position

Возможные значения: bottom, under

Расположение (bottom: под всем письмом, under: после ответа)

signs

Управление подписями

ya360 mailbox sender signs [-h] {show,save,add,edit,delete} ...

Позиционные аргументы

sub_com_signs: Возможные значения: show, save, add, edit, delete

Команды:

show

Отобразить подписи

ya360 mailbox sender signs show [-h] nickname

Позиционные аргументы

nickname: Login пользователя почтового ящика

save

Сохранить подпись в файл

ya360 mailbox sender signs save [-h] nickname num filename

Позиционные аргументы

nickname: Login пользователя почтового ящика
num: Номер подписи
filename: Имя файла

add

Добавить новую подпись

ya360 mailbox sender signs add [-h] nickname {True,False} emails lang filename

Позиционные аргументы

nickname

Login пользователя почтового ящика

isDefault

Возможные значения: True, False

Признак основной подписи

emails

Список адресов для ассоциирования

lang

Язык

filename

Имя файла с текстом подписи

edit

Редактировать подпись

ya360 mailbox sender signs edit [-h] [--isDefault {True,False}]
                                [--emails EMAILS] [--lang LANG]
                                [--filename FILENAME]
                                nickname num

Позиционные аргументы

nickname: Login пользователя почтового ящика
num: Номер подписи

Опции

--isDefault

Возможные значения: True, False

Признак основной подписи

--emails

Список адресов для ассоциирования

--lang

Язык

--filename

Имя файла с текстом подписи

delete

Удалить подпись

ya360 mailbox sender signs delete [-h] nickname num

Позиционные аргументы

nickname: Login пользователя почтового ящика
num: Номер подписи

logs

Аудит-лог событий в организации

ya360 logs [-h] {mail,disk} ...

Позиционные аргументы

sub_com_logs: Возможные значения: mail, disk

Команды:

mail

Аудит-лог почты

ya360 logs mail [-h] [--beforeDate BEFOREDATE] [--afterDate AFTERDATE]
                [--includeUsers INCLUDEUSERS] [--excludeUsers EXCLUDEUSERS]
                [--types TYPES] [--csv CSV]

Опции

--beforeDate: Верхняя граница периода выборки в формате ISO 8601
--afterDate: Нижняя граница периода выборки в формате ISO 8601
--includeUsers: Список пользователей, действия которых должны быть включены в список событий
--excludeUsers: Список пользователей, действия которых должны быть исключены из списка событий
--types: Типы событий которые должны быть включены в список. По умолчанию включаются все события
--csv: Выгрузить в CSV файл

disk

Аудит-лог диска

ya360 logs disk [-h] [--beforeDate BEFOREDATE] [--afterDate AFTERDATE]
                [--includeUsers INCLUDEUSERS] [--excludeUsers EXCLUDEUSERS]
                [--types TYPES] [--csv CSV]

Опции

--beforeDate: Верхняя граница периода выборки в формате ISO 8601
--afterDate: Нижняя граница периода выборки в формате ISO 8601
--includeUsers: Список пользователей, действия которых должны быть включены в список событий
--excludeUsers: Список пользователей, действия которых должны быть исключены из списка событий
--types: Типы событий которые должны быть включены в список. По умолчанию включаются все события
--csv: Выгрузить в CSV файл

antispam

Антиспам

ya360 antispam [-h] {show,add,remove,delete} ...

Позиционные аргументы

sub_com_antispam: Возможные значения: show, add, remove, delete

Команды:

show

Показать содержимое белого списка

ya360 antispam show [-h]

add

Добавить в белый список

ya360 antispam add [-h] ipcidr

Позиционные аргументы

ipcidr: Адрес или CIDR

remove

Удалить из белого списка

ya360 antispam remove [-h] ipcidr

Позиционные аргументы

ipcidr: Адрес или CIDR

delete

Опасно

Данную операцию невозможно отменить!

Очистить белый список

ya360 antispam delete [-h]

routing

Предупреждение

Экспериментальный набор команд для правил маршрутизации почты. Доступен ограниченному набору тестировщиков.

ya360 routing [-h] {show,add,remove} ...

Позиционные аргументы

sub_com_routing: Возможные значения: show, add, remove

Команды:

show

Показать содержимое таблицы правил

ya360 routing show [-h]

add

Добавить правило

ya360 routing add [-h] [-P POSITION] rule

Позиционные аргументы

rule: Правило

Опции

-P, --position: Позиция

remove

Удалить правило

ya360 routing remove [-h] position

Позиционные аргументы

position: Позиция

make-config

Создание конфигурационного файла

ya360 make-config [-h]